From: Waiman Long <longman@redhat.com>
To: Matthew Wilcox <willy@infradead.org>
Cc: "Luis R. Rodriguez" <mcgrof@kernel.org>,
Kees Cook <keescook@chromium.org>,
linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org,
Andrew Morton <akpm@linux-foundation.org>,
Al Viro <viro@zeniv.linux.org.uk>
Subject: Re: [PATCH v2 1/5] sysctl: Add kdoc comments to do_proc_do{u}intvec_minmax_conv_param
Date: Tue, 27 Feb 2018 16:52:13 -0500 [thread overview]
Message-ID: <14cad206-114f-3320-8818-8799fad4e10e@redhat.com> (raw)
In-Reply-To: <20180227211022.GB29918@bombadil.infradead.org>
On 02/27/2018 04:10 PM, Matthew Wilcox wrote:
> On Tue, Feb 27, 2018 at 03:49:47PM -0500, Waiman Long wrote:
>> +/**
>> + * DOC: do_proc_dointvec_minmax_conv_param
>> + *
>> + * The do_proc_dointvec_minmax_conv_param structure provides the
>> + * minimum and maximum values for doing range checking for those sysctl
>> + * parameters that use the proc_dointvec_minmax() handler. The error
>> + * code -EINVAL will be returned if the range check fails.
>> + *
>> + * min: ptr to minimum allowable value
>> + * max: ptr to maximum allowable value
>> + */
> This isn't how to document a struct; see Documentation/doc-guide/kernel-doc.rst
>
> /**
> * struct do_proc_dointvec_minmax_conv_param - Range checking for sysctls
> * @min: Pointer to minimum allowable value.
> * @max: Pointer to maximum allowable value.
> *
> * Provides the minimum and maximum values allowed for a parameter. A
> * pointer to this structure should be passed to proc_dointvec_minmax().
> */
>
> Also, it's inappropriate to document the return value from
> proc_dointvec_minmax() here; that should be in the kernel-doc for the
> function.
>
Thanks for the advice. I will change the comments in the v3 patch.
-Longman
next prev parent reply other threads:[~2018-02-27 21:52 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-27 20:49 [PATCH v2 0/5] ipc: Clamp *mni to the real IPCMNI limit Waiman Long
2018-02-27 20:49 ` [PATCH v2 1/5] sysctl: Add kdoc comments to do_proc_do{u}intvec_minmax_conv_param Waiman Long
2018-02-27 21:10 ` Matthew Wilcox
2018-02-27 21:52 ` Waiman Long [this message]
2018-02-27 20:49 ` [PATCH v2 2/5] sysctl: Add flags to support min/max range clamping Waiman Long
2018-02-28 0:47 ` Luis R. Rodriguez
2018-02-28 17:53 ` Waiman Long
2018-02-28 18:43 ` Luis R. Rodriguez
2018-02-28 18:58 ` Waiman Long
2018-02-28 19:06 ` Luis R. Rodriguez
2018-03-01 17:40 ` Waiman Long
2018-02-27 20:49 ` [PATCH v2 3/5] sysctl: Warn when a clamped sysctl parameter is set out of range Waiman Long
2018-02-28 0:57 ` Luis R. Rodriguez
2018-02-28 17:55 ` Waiman Long
2018-02-27 20:49 ` [PATCH v2 4/5] ipc: Clamp msgmni and shmmni to the real IPCMNI limit Waiman Long
2018-02-28 1:01 ` Luis R. Rodriguez
2018-02-28 17:56 ` Waiman Long
2018-02-27 20:49 ` [PATCH v2 5/5] ipc: Clamp semmni " Waiman Long
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=14cad206-114f-3320-8818-8799fad4e10e@redhat.com \
--to=longman@redhat.com \
--cc=akpm@linux-foundation.org \
--cc=keescook@chromium.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mcgrof@kernel.org \
--cc=viro@zeniv.linux.org.uk \
--cc=willy@infradead.org \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).