linux-kernel - Re: [PATCH] certs: system_keyring.c: clean up kernel-doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <b7936a1c-6f7a-f7ed-6d46-a5affef770a5@infradead.org>
Date:   Sun, 31 Oct 2021 15:30:03 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Mimi Zohar <zohar@...ux.ibm.com>, linux-kernel@...r.kernel.org
Cc:     David Howells <dhowells@...hat.com>,
        David Woodhouse <dwmw2@...radead.org>, keyrings@...r.kernel.org
Subject: Re: [PATCH] certs: system_keyring.c: clean up kernel-doc

On 10/27/21 5:12 PM, Mimi Zohar wrote:
> Hi Randy,
> 
> On Sun, 2021-10-24 at 17:38 -0700, Randy Dunlap wrote:
>> Fix some kernel-doc warnings in system_keyring.c:
>>
>> system_keyring.c:43: warning: expecting prototype for restrict_link_to_builtin_trusted(). Prototype was for restrict_link_by_builtin_trusted() instead
>> system_keyring.c:77: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>   * Allocate a struct key_restriction for the "builtin and secondary trust"
>> system_keyring.c:77: warning: missing initial short description on line:
>>   * Allocate a struct key_restriction for the "builtin and secondary trust"
>>
>> Fix the warnings above and then see & fix these:
>>
>> system_keyring.c:43: warning: No description found for return value of 'restrict_link_by_builtin_trusted'
>> system_keyring.c:62: warning: No description found for return value of 'restrict_link_by_builtin_and_secondary_trusted'
>> system_keyring.c:190: warning: No description found for return value of 'verify_pkcs7_message_sig'
>> system_keyring.c:275: warning: No description found for return value of 'verify_pkcs7_signature'
>>
>> This still leaves non-exported two functions that do not have their
>> functions parameters documented: restrict_link_by_builtin_trusted() and
>> restrict_link_by_builtin_and_secondary_trusted().
>>
>> Use '%' preceding constants in kernel-doc notation.
>>
>> Use "builtin" consistently instead of "built in" or "built-in".
>>
>> Don't use "/**" to begin a comment that is not in kernel-doc format.
>>
>> Document the use of VERIFY_USE_SECONDARY_KEYRING and
>> VERIFY_USE_PLATFORM_KEYRING.
>>
> 
> Thanks, Randy.  Even after these changes there are additional kernel
> doc warnings.   Missing are the parameter definitions for
> restrict_link_by_builtin_trusted() and
> restrict_link_by_builtin_and_secondary_trusted().   The first three are
> exactly the same as for restrict_link_by_signature().  The fourth parm
> needs to be tweaked.

Ah, thanks for the info. I'll update the patch...

-- 
~Randy