Re: [PATCH] init_module.2: Document MODULE_INIT_COMPRESS_FILE flag

[Alejandro Colomar <alx@kernel.org>]

[-- Attachment #1: Type: text/plain, Size: 1476 bytes --]

Hi Michael,

On Tue, Apr 02, 2024 at 01:07:12PM +0200, Michael Weiß wrote:
> >>  .TP
> >>  .B EINVAL
> >>  .I flags
> >> -is invalid.
> >> +is invalid or the decompressor sanity checks failed while loading
> >> +a compressed module with flag
> >> +.BR CONFIG_MODULE_DECOMPRESS
> > 
> > This should use B, not BR.  (It uses Bold, not Bold/Roman alternating.)
> >
> I spotted another error here, too. Should be: 
> 
> 	.B MODULE_INIT_COMPRESSED_FILE
> 
> I'll fix that in v2.

Also, the two conditions seem different enough that I would split them
into two EINVAL entries.

>  
> >> +set.
> >>  .TP
> >>  .B ENOEXEC
> >>  .I fd
> >>  does not refer to an open file.
> >>  .TP
> >> +.BR EOPNOTSUPP " (since Linux 5.17)"
> >> +This error is return if the kernel was configured without
> > 
> > The first words seems redundant.  I'd use:
> > 
> > 	The kernel was configured without CONFIG_MODULE_DECOMPRESS.
> > 
> > Which seems incomplete.  I guess if the module is not compressed, then
> > it won't report this error.
> > 
> > 	The module is compressed, and the kernel was built without ...
> 
> True. But I would write:
> 
> 	The flag
> 	.B MODULE_INIT_COMPRESSED_FILE
> 	is set to load a compressed module,
> 	and the kernel was built without
> 	.BR CONFIG_MODULE_DECOMPRESS .
> 
> Since the error directly dependents on a check of the flag.

Agree.

Have a lovely day!
Alex


-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]