LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Kees Cook <keescook@chromium.org>
To: Thomas Gleixner <tglx@linutronix.de>
Cc: linux-kernel@vger.kernel.org
Subject: [PATCH] rslib: Document rs_control "buffers" field
Date: Tue, 24 Apr 2018 15:46:49 -0700	[thread overview]
Message-ID: <20180424224649.GA2250@beast> (raw)

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

                 reply	other threads:[~2018-04-24 22:46 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180424224649.GA2250@beast \
    --to=keescook@chromium.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=tglx@linutronix.de \
    --subject='Re: [PATCH] rslib: Document rs_control "buffers" field' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

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