linux-kernel - Re: [PATCH -next] blktrace: Fix some kernel-doc comments

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: <5a245067-7adb-c482-3ea4-22beb81fa719@acm.org>
Date:   Mon, 18 Jul 2022 06:41:52 -0700
From:   Bart Van Assche <bvanassche@....org>
To:     Yang Li <yang.lee@...ux.alibaba.com>, rostedt@...dmis.org
Cc:     axboe@...nel.dk, mingo@...hat.com, linux-block@...r.kernel.org,
        linux-kernel@...r.kernel.org, Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next] blktrace: Fix some kernel-doc comments

On 7/17/22 23:17, Yang Li wrote:
> Remove warnings found by running scripts/kernel-doc, which is caused by
> using 'make W=1'.
> kernel/trace/blktrace.c:1884: warning: Function parameter or member 'opf' not described in 'blk_fill_rwbs'
> kernel/trace/blktrace.c:1884: warning: Excess function parameter 'op' description in 'blk_fill_rwbs'
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
> ---
>   kernel/trace/blktrace.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/kernel/trace/blktrace.c b/kernel/trace/blktrace.c
> index 150058f5daa9..5632b6159d88 100644
> --- a/kernel/trace/blktrace.c
> +++ b/kernel/trace/blktrace.c
> @@ -1873,7 +1873,7 @@ static ssize_t sysfs_blk_trace_attr_store(struct device *dev,
>   /**
>    * blk_fill_rwbs - Fill the buffer rwbs by mapping op to character string.
>    * @rwbs:	buffer to be filled
> - * @op:		REQ_OP_XXX for the tracepoint
> + * @opf:	a combination of a request operation and request flags
>    *
>    * Description:
>    *     Maps the REQ_OP_XXX to character and fills the buffer provided by the

A patch similar to the above patch should already have been queued by 
Jens Axboe. See also "[PATCH 0/2] Fix recently introduced kernel-doc 
warnings" 
(https://lore.kernel.org/all/165797480617.363028.4687340933765044343.b4-ty@kernel.dk/).

Thanks,

Bart.