Messages in this thread | | | Date | Tue, 27 Feb 2018 13:10:22 -0800 | From | Matthew Wilcox <> | Subject | Re: [PATCH v2 1/5] sysctl: Add kdoc comments to do_proc_do{u}intvec_minmax_conv_param |
| |
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.
| |