* [PATCH] reed_solomon: Fix kernel-doc
@ 2018-07-03 19:43 Matthew Wilcox
2018-07-03 19:47 ` Kees Cook
0 siblings, 1 reply; 3+ messages in thread
From: Matthew Wilcox @ 2018-07-03 19:43 UTC (permalink / raw)
To: linux-doc
Cc: Matthew Wilcox, Jonathan Corbet, Thomas Gleixner, Kees Cook,
linux-kernel
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>
---
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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] reed_solomon: Fix kernel-doc
2018-07-03 19:43 [PATCH] reed_solomon: Fix kernel-doc Matthew Wilcox
@ 2018-07-03 19:47 ` Kees Cook
2018-07-03 19:52 ` Jonathan Corbet
0 siblings, 1 reply; 3+ messages in thread
From: Kees Cook @ 2018-07-03 19:47 UTC (permalink / raw)
To: Matthew Wilcox; +Cc: linux-doc, Jonathan Corbet, Thomas Gleixner, LKML
On Tue, Jul 3, 2018 at 12:43 PM, Matthew Wilcox <willy@infradead.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@infradead.org>
Acked-by: Kees Cook <keescook@chromium.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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] reed_solomon: Fix kernel-doc
2018-07-03 19:47 ` Kees Cook
@ 2018-07-03 19:52 ` Jonathan Corbet
0 siblings, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2018-07-03 19:52 UTC (permalink / raw)
To: Kees Cook; +Cc: Matthew Wilcox, linux-doc, Thomas Gleixner, LKML
On Tue, 3 Jul 2018 12:47:44 -0700
Kees Cook <keescook@chromium.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@infradead.org>
>
> Acked-by: Kees Cook <keescook@chromium.org>
>
> Jon can you take this?
Will do.
Thanks,
jon
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2018-07-03 19:52 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-07-03 19:43 [PATCH] reed_solomon: Fix kernel-doc Matthew Wilcox
2018-07-03 19:47 ` Kees Cook
2018-07-03 19:52 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).