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
