reed_solomon: Fix kernel-doc
authorMatthew Wilcox <willy@infradead.org>
Tue, 3 Jul 2018 19:43:54 +0000 (12:43 -0700)
committerJonathan Corbet <corbet@lwn.net>
Tue, 10 Jul 2018 21:00:52 +0000 (15:00 -0600)
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@infradead.org>
Acked-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
lib/reed_solomon/reed_solomon.c

index d8bb1a1..e5fdc8b 100644 (file)
@@ -283,7 +283,7 @@ out:
  *             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)