mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Bart Van Assche <bvanassche@acm.org>
To: Yang Li <yang.lee@linux.alibaba.com>, rostedt@goodmis.org
Cc: axboe@kernel.dk, mingo@redhat.com, linux-block@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Abaci Robot <abaci@linux.alibaba.com>
Subject: Re: [PATCH -next] blktrace: Fix some kernel-doc comments
Date: Mon, 18 Jul 2022 06:41:52 -0700	[thread overview]
Message-ID: <5a245067-7adb-c482-3ea4-22beb81fa719@acm.org> (raw)
In-Reply-To: <20220718061755.114599-1-yang.lee@linux.alibaba.com>

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.

      reply	other threads:[~2022-07-18 13:41 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-18  6:17 Yang Li
2022-07-18 13:41 ` Bart Van Assche [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5a245067-7adb-c482-3ea4-22beb81fa719@acm.org \
    --to=bvanassche@acm.org \
    --cc=abaci@linux.alibaba.com \
    --cc=axboe@kernel.dk \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=rostedt@goodmis.org \
    --cc=yang.lee@linux.alibaba.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®