linux-kernel - Re: [PATCH] nilfs2: cpfile: fix some kernel-doc warnings

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]

Date: Tue, 19 Dec 2023 23:28:44 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Ryusuke Konishi <konishi.ryusuke@...il.com>
Cc: linux-kernel@...r.kernel.org, linux-nilfs@...r.kernel.org
Subject: Re: [PATCH] nilfs2: cpfile: fix some kernel-doc warnings



On 12/19/23 23:25, Ryusuke Konishi wrote:
> On Wed, Dec 20, 2023 at 3:59 PM Randy Dunlap wrote:
>>
>> Correct the function parameter names for nilfs_cpfile_get_info():
>>
>> cpfile.c:564: warning: Function parameter or member 'cnop' not described in 'nilfs_cpfile_get_cpinfo'
>> cpfile.c:564: warning: Function parameter or member 'mode' not described in 'nilfs_cpfile_get_cpinfo'
>> cpfile.c:564: warning: Function parameter or member 'buf' not described in 'nilfs_cpfile_get_cpinfo'
>> cpfile.c:564: warning: Function parameter or member 'cisz' not described in 'nilfs_cpfile_get_cpinfo'
>> cpfile.c:564: warning: Excess function parameter 'cno' description in 'nilfs_cpfile_get_cpinfo'
>> cpfile.c:564: warning: Excess function parameter 'ci' description in 'nilfs_cpfile_get_cpinfo'
>>
>> This still leaves a few kernel-doc warnings.
>> Also, the function parameters should have descriptions after them.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
>> Cc: Ryusuke Konishi <konishi.ryusuke@...il.com>
>> Cc: linux-nilfs@...r.kernel.org
>> ---
>>  fs/nilfs2/cpfile.c |    6 ++++--
>>  1 file changed, 4 insertions(+), 2 deletions(-)
>>
>> diff -- a/fs/nilfs2/cpfile.c b/fs/nilfs2/cpfile.c
>> --- a/fs/nilfs2/cpfile.c
>> +++ b/fs/nilfs2/cpfile.c
>> @@ -554,8 +554,10 @@ static ssize_t nilfs_cpfile_do_get_ssinf
>>  /**
>>   * nilfs_cpfile_get_cpinfo -
>>   * @cpfile:
>> - * @cno:
>> - * @ci:
>> + * @cnop:
>> + * @mode:
>> + * @buf:
>> + * @cisz:
>>   * @nci:
>>   */
>>
> 
> Ah, thank you for pointing it out.
> 
> I would like to fill in the missing descriptions and send it upstream.

Yes, please do.

Thanks.

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html