rslib: Document rs_control "buffers" field

PATCH New Kees Cook 1 participant 1 message Apr 24, 2018

lore

Share & tools

lore

Kees Cook

author

2018-04-24 22:46 UTC #0 lore raw

PATCH 1/1 rslib: Document rs_control "buffers" field

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

Quoted 1 line

Quoted 1 line
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 <[email protected]>

Cc Thomas Gleixner <[email protected]>

---
Adding this to my vla/rslib tree...

---
 include/linux/rslib.h | 1 +
 1 file changed, 1 insertion(+)

include/linux/rslib.h +1 -0

index 9dc36cae45e9..0ae635bc6d5a 100644
@@ -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;

Signature · 6 lines

2.7.4


-- 
Kees Cook
Pixel Security