linux-kernel - Re: [PATCH] reed_solomon: Fix kernel-doc

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAGXu5jKN2HTno=1MfAug+pn0yf82tV-YAWURpx6v_xk7spc4mA@mail.gmail.com>
Date:   Tue, 3 Jul 2018 12:47:44 -0700
From:   Kees Cook <keescook@...omium.org>
To:     Matthew Wilcox <willy@...radead.org>
Cc:     linux-doc@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Thomas Gleixner <tglx@...utronix.de>,
        LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] reed_solomon: Fix kernel-doc

On Tue, Jul 3, 2018 at 12:43 PM, Matthew Wilcox <willy@...radead.org> wrote:
> The current doc build warns:
> ./lib/reed_solomon/reed_solomon.c:287: WARNING: Unknown target name: "gfp".
>
> This is because it misinterprets the "GFP_" that is part of the
> description.  Change the description to avoid the problem.
>
> Signed-off-by: Matthew Wilcox <willy@...radead.org>

Acked-by: Kees Cook <keescook@...omium.org>

Jon can you take this?

-Kees

> ---
>  lib/reed_solomon/reed_solomon.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/lib/reed_solomon/reed_solomon.c b/lib/reed_solomon/reed_solomon.c
> index d8bb1a1eba72..e5fdc8b9e856 100644
> --- a/lib/reed_solomon/reed_solomon.c
> +++ b/lib/reed_solomon/reed_solomon.c
> @@ -283,7 +283,7 @@ static struct rs_control *init_rs_internal(int symsize, int gfpoly,
>   *             in index form
>   *  @prim:     primitive element to generate polynomial roots
>   *  @nroots:   RS code generator polynomial degree (number of roots)
> - *  @gfp:      GFP_ flags for allocations
> + *  @gfp:      Memory allocation flags.
>   */
>  struct rs_control *init_rs_gfp(int symsize, int gfpoly, int fcr, int prim,
>                                int nroots, gfp_t gfp)
> --
> 2.18.0
>



-- 
Kees Cook
Pixel Security