linux-kernel - Re: [PATCH] ubifs: fix 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: Mon, 6 May 2024 10:11:53 +0800
From: Zhihao Cheng <chengzhihao1@...wei.com>
To: Jeff Johnson <quic_jjohnson@...cinc.com>, Richard Weinberger
	<richard@....at>
CC: <linux-mtd@...ts.infradead.org>, <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] ubifs: fix kernel-doc warnings

在 2024/5/3 4:16, Jeff Johnson 写道:
> make C=1 reports the following kernel-doc warnings:
> 
> fs/ubifs/compress.c:103: warning: Function parameter or struct member 'c' not described in 'ubifs_compress'
> fs/ubifs/compress.c:155: warning: Function parameter or struct member 'c' not described in 'ubifs_decompress'
> fs/ubifs/find.c:353: warning: Excess function parameter 'data' description in 'scan_for_free_cb'
> fs/ubifs/find.c:353: warning: Function parameter or struct member 'arg' not described in 'scan_for_free_cb'
> fs/ubifs/find.c:594: warning: Excess function parameter 'data' description in 'scan_for_idx_cb'
> fs/ubifs/find.c:594: warning: Function parameter or struct member 'arg' not described in 'scan_for_idx_cb'
> fs/ubifs/find.c:786: warning: Excess function parameter 'data' description in 'scan_dirty_idx_cb'
> fs/ubifs/find.c:786: warning: Function parameter or struct member 'arg' not described in 'scan_dirty_idx_cb'
> fs/ubifs/find.c:86: warning: Excess function parameter 'data' description in 'scan_for_dirty_cb'
> fs/ubifs/find.c:86: warning: Function parameter or struct member 'arg' not described in 'scan_for_dirty_cb'
> fs/ubifs/journal.c:369: warning: expecting prototype for wake_up_reservation(). Prototype was for add_or_start_queue() instead
> fs/ubifs/lprops.c:1018: warning: Excess function parameter 'lst' description in 'scan_check_cb'
> fs/ubifs/lprops.c:1018: warning: Function parameter or struct member 'arg' not described in 'scan_check_cb'
> fs/ubifs/lpt.c:1938: warning: Function parameter or struct member 'ptr' not described in 'lpt_scan_node'
> fs/ubifs/replay.c:60: warning: Function parameter or struct member 'hash' not described in 'replay_entry'
> 
> Fix them.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@...cinc.com>
> ---
> Note ubifs still has C=1 warnings from smatch that are not addressed:

Reviewed-by: Zhihao Cheng <chengzhihao1@...wei.com>
> 
[...]
> diff --git a/fs/ubifs/journal.c b/fs/ubifs/journal.c
> index 74aee92433d7..f997a85bcdce 100644
> --- a/fs/ubifs/journal.c
> +++ b/fs/ubifs/journal.c
> @@ -359,7 +359,7 @@ static void wake_up_reservation(struct ubifs_info *c)
>   }
>   
>   /**
> - * wake_up_reservation - add current task in queue or start queuing.
> + * add_or_start_queue - add current task in queue or start queuing.
>    * @c: UBIFS file-system description object
>    *
>    * This function starts queuing if queuing is not started, otherwise adds

This period of code was modified in previous patch 
https://patchwork.ozlabs.org/project/linux-mtd/patch/20240227024204.1080739-1-chengzhihao1@huawei.com/ 
, I'm okay to drop the old patch and apply this one.