linux-kernel - [PATCH] rslib: Document rs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20180424224649.GA2250@beast>
Date:   Tue, 24 Apr 2018 15:46:49 -0700
From:   Kees Cook <keescook@...omium.org>
To:     Thomas Gleixner <tglx@...utronix.de>
Cc:     linux-kernel@...r.kernel.org
Subject: [PATCH] rslib: Document rs_control "buffers" field

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@...omium.org>
Cc: Thomas Gleixner <tglx@...utronix.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