[PATCH] rslib: Document rs_control "buffers" field

From: Kees Cook
Date: Tue Apr 24 2018 - 18:46:56 EST


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@xxxxxxxxxxxx>
Cc: Thomas Gleixner <tglx@xxxxxxxxxxxxx>
---
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