LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] rslib: Document rs_control "buffers" field
@ 2018-04-24 22:46 Kees Cook
  0 siblings, 0 replies; only message in thread
From: Kees Cook @ 2018-04-24 22:46 UTC (permalink / raw)
  To: Thomas Gleixner; +Cc: linux-kernel

Fix htmldocs complaint about lack of documentation of the buffers field:

>> include/linux/rslib.h:56: warning: Function parameter or member 'buffers' not described in 'rs_control'

Fixes: 12a154e7697c ("rslib: Allocate decoder buffers to avoid VLAs")
Signed-off-by: Kees Cook <keescook@chromium.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
---
Adding this to my vla/rslib tree...
---
 include/linux/rslib.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/linux/rslib.h b/include/linux/rslib.h
index 9dc36cae45e9..0ae635bc6d5a 100644
--- a/include/linux/rslib.h
+++ b/include/linux/rslib.h
@@ -48,6 +48,7 @@ struct rs_codec {
 /**
  * struct rs_control - rs control structure per instance
  * @codec:	The codec used for this instance
+ * @buffers:	Internal scratch buffers used in calls to decode_rs()
  */
 struct rs_control {
 	struct rs_codec	*codec;
-- 
2.7.4


-- 
Kees Cook
Pixel Security

^ permalink raw reply	[flat|nested] only message in thread
only message in thread, other threads:[~2018-04-24 22:46 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-04-24 22:46 [PATCH] rslib: Document rs_control "buffers" field Kees Cook

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).