Re: [PATCH] reed_solomon: Fix kernel-doc
From: Kees Cook
Date: Tue Jul 03 2018 - 15:47:52 EST
On Tue, Jul 3, 2018 at 12:43 PM, Matthew Wilcox <willy@xxxxxxxxxxxxx> 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@xxxxxxxxxxxxx>
Acked-by: Kees Cook <keescook@xxxxxxxxxxxx>
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