From: John Ogness <john.ogness@linutronix.de>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Petr Mladek <pmladek@suse.com>,
Sergey Senozhatsky <sergey.senozhatsky@gmail.com>,
Steven Rostedt <rostedt@goodmis.org>,
linux-kernel@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: Re: [PATCH] printk: rectify kernel-doc for prb_rec_init_wr()
Date: Mon, 25 Jan 2021 10:19:26 +0106 [thread overview]
Message-ID: <871re94bwp.fsf@jogness.linutronix.de> (raw)
In-Reply-To: <20210125081748.19903-1-lukas.bulwahn@gmail.com>
On 2021-01-25, Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
> The command 'find ./kernel/printk/ | xargs ./scripts/kernel-doc -none'
> reported a mismatch with the kernel-doc of prb_rec_init_wr().
>
> Rectify the kernel-doc, such that no issues remain for ./kernel/printk/.
>
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
Reviewed-by: John Ogness <john.ogness@linutronix.de>
> ---
> applies cleanly on v5.11-rc5 and next-20210122
>
> John, please ack.
> Petr, please pick this minor typo fixup.
>
> kernel/printk/printk_ringbuffer.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/kernel/printk/printk_ringbuffer.h b/kernel/printk/printk_ringbuffer.h
> index 5dc9d022db07..73cc80e01cef 100644
> --- a/kernel/printk/printk_ringbuffer.h
> +++ b/kernel/printk/printk_ringbuffer.h
> @@ -287,7 +287,7 @@ _DEFINE_PRINTKRB(name, descbits, avgtextbits, &_##name##_text[0])
> /* Writer Interface */
>
> /**
> - * prb_rec_init_wd() - Initialize a buffer for writing records.
> + * prb_rec_init_wr() - Initialize a buffer for writing records.
> *
> * @r: The record to initialize.
> * @text_buf_size: The needed text buffer size.
> --
> 2.17.1
next prev parent reply other threads:[~2021-01-25 9:25 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-25 8:17 [PATCH] printk: rectify kernel-doc for prb_rec_init_wr() Lukas Bulwahn
2021-01-25 9:13 ` John Ogness [this message]
2021-01-26 10:27 ` Petr Mladek
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=871re94bwp.fsf@jogness.linutronix.de \
--to=john.ogness@linutronix.de \
--cc=corbet@lwn.net \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=mchehab+huawei@kernel.org \
--cc=pmladek@suse.com \
--cc=rostedt@goodmis.org \
--cc=sergey.senozhatsky@gmail.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