linux-kernel - Re: [PATCH] printk: rectify kernel-doc for prb_rec_init

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <871re94bwp.fsf@jogness.linutronix.de>
Date:   Mon, 25 Jan 2021 10:19:26 +0106
From:   John Ogness <john.ogness@...utronix.de>
To:     Lukas Bulwahn <lukas.bulwahn@...il.com>,
        Petr Mladek <pmladek@...e.com>,
        Sergey Senozhatsky <sergey.senozhatsky@...il.com>,
        Steven Rostedt <rostedt@...dmis.org>,
        linux-kernel@...r.kernel.org
Cc:     Jonathan Corbet <corbet@....net>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        linux-doc@...r.kernel.org, kernel-janitors@...r.kernel.org,
        Lukas Bulwahn <lukas.bulwahn@...il.com>
Subject: Re: [PATCH] printk: rectify kernel-doc for prb_rec_init_wr()

On 2021-01-25, Lukas Bulwahn <lukas.bulwahn@...il.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@...il.com>

Reviewed-by: John Ogness <john.ogness@...utronix.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