lkml.org 
[lkml]   [2022]   [Jul]   [18]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
SubjectRe: [PATCH -next] blktrace: Fix some kernel-doc comments
From
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@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.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.

\
 
 \ /
  Last update: 2022-07-18 15:42    [W:0.031 / U:0.340 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site