[PATCH] sysctl: Add missing kernel-doc for proc_dointvec_conv

[PATCH] sysctl: Add missing kernel-doc for proc_dointvec_conv

[Joel Granados]

Add kernel-doc documentation for the proc_dointvec_conv function to
describe its parameters and return value.

Signed-off-by: Joel Granados <joel.granados@kernel.org>
---
 kernel/sysctl.c | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/kernel/sysctl.c b/kernel/sysctl.c
index 2cd767b9680eb696efeae06f436548777b1b6844..b589f50d62854985c4c063232c95bd7590434738 100644
--- a/kernel/sysctl.c
+++ b/kernel/sysctl.c
@@ -862,6 +862,22 @@ int proc_doulongvec_minmax(const struct ctl_table *table, int dir,
 	return proc_doulongvec_minmax_conv(table, dir, buffer, lenp, ppos, 1l, 1l);
 }
 
+/**
+ * proc_dointvec_conv - read a vector of ints with a custom converter
+ * @table: the sysctl table
+ * @dir: %TRUE if this is a write to the sysctl file
+ * @buffer: the user buffer
+ * @lenp: the size of the user buffer
+ * @ppos: file position
+ * @conv: Custom converter call back
+ *
+ * Reads/writes up to table->maxlen/sizeof(unsigned int) unsigned integer
+ * values from/to the user buffer, treated as an ASCII string. Negative
+ * strings are not allowed.
+ *
+ * Returns 0 on success
+ */
+
 int proc_dointvec_conv(const struct ctl_table *table, int dir, void *buffer,
 		       size_t *lenp, loff_t *ppos,
 		       int (*conv)(bool *negp, unsigned long *u_ptr, int *k_ptr,

---
base-commit: 8f0b4cce4481fb22653697cced8d0d04027cb1e8
change-id: 20251215-jag-sysctl-doc-d3cb5bd14699

Best regards,
-- 
Joel Granados <joel.granados@kernel.org>

Re: [PATCH] sysctl: Add missing kernel-doc for proc_dointvec_conv

[Kees Cook]

On Mon, Dec 15, 2025 at 04:52:58PM +0100, Joel Granados wrote:
> Add kernel-doc documentation for the proc_dointvec_conv function to
> describe its parameters and return value.
> 
> Signed-off-by: Joel Granados <joel.granados@kernel.org>
> ---
>  kernel/sysctl.c | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 
> diff --git a/kernel/sysctl.c b/kernel/sysctl.c
> index 2cd767b9680eb696efeae06f436548777b1b6844..b589f50d62854985c4c063232c95bd7590434738 100644
> --- a/kernel/sysctl.c
> +++ b/kernel/sysctl.c
> @@ -862,6 +862,22 @@ int proc_doulongvec_minmax(const struct ctl_table *table, int dir,
>  	return proc_doulongvec_minmax_conv(table, dir, buffer, lenp, ppos, 1l, 1l);
>  }
>  
> +/**
> + * proc_dointvec_conv - read a vector of ints with a custom converter
> + * @table: the sysctl table
> + * @dir: %TRUE if this is a write to the sysctl file
> + * @buffer: the user buffer
> + * @lenp: the size of the user buffer
> + * @ppos: file position
> + * @conv: Custom converter call back
> + *
> + * Reads/writes up to table->maxlen/sizeof(unsigned int) unsigned integer
> + * values from/to the user buffer, treated as an ASCII string. Negative
> + * strings are not allowed.
> + *
> + * Returns 0 on success

I think kern-doc expects "Returns:" rather than "Returns". But
otherwise, yes! :)

Reviewed-by: Kees Cook <kees@kernel.org>

-Kees

> + */
> +
>  int proc_dointvec_conv(const struct ctl_table *table, int dir, void *buffer,
>  		       size_t *lenp, loff_t *ppos,
>  		       int (*conv)(bool *negp, unsigned long *u_ptr, int *k_ptr,
> 
> ---
> base-commit: 8f0b4cce4481fb22653697cced8d0d04027cb1e8
> change-id: 20251215-jag-sysctl-doc-d3cb5bd14699
> 
> Best regards,
> -- 
> Joel Granados <joel.granados@kernel.org>
> 
> 

-- 
Kees Cook

Re: [PATCH] sysctl: Add missing kernel-doc for proc_dointvec_conv

[Joel Granados]

[-- Attachment #1: Type: text/plain, Size: 2088 bytes --]

On Tue, Dec 16, 2025 at 12:40:15AM -0800, Kees Cook wrote:
> On Mon, Dec 15, 2025 at 04:52:58PM +0100, Joel Granados wrote:
> > Add kernel-doc documentation for the proc_dointvec_conv function to
> > describe its parameters and return value.
> > 
> > Signed-off-by: Joel Granados <joel.granados@kernel.org>
> > ---
> >  kernel/sysctl.c | 16 ++++++++++++++++
> >  1 file changed, 16 insertions(+)
> > 
> > diff --git a/kernel/sysctl.c b/kernel/sysctl.c
> > index 2cd767b9680eb696efeae06f436548777b1b6844..b589f50d62854985c4c063232c95bd7590434738 100644
> > --- a/kernel/sysctl.c
> > +++ b/kernel/sysctl.c
> > @@ -862,6 +862,22 @@ int proc_doulongvec_minmax(const struct ctl_table *table, int dir,
> >  	return proc_doulongvec_minmax_conv(table, dir, buffer, lenp, ppos, 1l, 1l);
> >  }
> >  
> > +/**
> > + * proc_dointvec_conv - read a vector of ints with a custom converter
> > + * @table: the sysctl table
> > + * @dir: %TRUE if this is a write to the sysctl file
> > + * @buffer: the user buffer
> > + * @lenp: the size of the user buffer
> > + * @ppos: file position
> > + * @conv: Custom converter call back
> > + *
> > + * Reads/writes up to table->maxlen/sizeof(unsigned int) unsigned integer
> > + * values from/to the user buffer, treated as an ASCII string. Negative
> > + * strings are not allowed.
> > + *
> > + * Returns 0 on success
> 
> I think kern-doc expects "Returns:" rather than "Returns". But
> otherwise, yes! :)
Will change locally. I wont resend as the change is trivial.

Thx
> 
> Reviewed-by: Kees Cook <kees@kernel.org>
> 
> -Kees
> 
> > + */
> > +
> >  int proc_dointvec_conv(const struct ctl_table *table, int dir, void *buffer,
> >  		       size_t *lenp, loff_t *ppos,
> >  		       int (*conv)(bool *negp, unsigned long *u_ptr, int *k_ptr,
> > 
> > ---
> > base-commit: 8f0b4cce4481fb22653697cced8d0d04027cb1e8
> > change-id: 20251215-jag-sysctl-doc-d3cb5bd14699
> > 
> > Best regards,
> > -- 
> > Joel Granados <joel.granados@kernel.org>
> > 
> > 
> 
> -- 
> Kees Cook

-- 

Joel Granados

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]

Re: [PATCH] sysctl: Add missing kernel-doc for proc_dointvec_conv

[Joel Granados]

[-- Attachment #1: Type: text/plain, Size: 2144 bytes --]

On Tue, Dec 16, 2025 at 12:40:15AM -0800, Kees Cook wrote:
> On Mon, Dec 15, 2025 at 04:52:58PM +0100, Joel Granados wrote:
> > Add kernel-doc documentation for the proc_dointvec_conv function to
> > describe its parameters and return value.
> > 
> > Signed-off-by: Joel Granados <joel.granados@kernel.org>
> > ---
> >  kernel/sysctl.c | 16 ++++++++++++++++
> >  1 file changed, 16 insertions(+)
> > 
> > diff --git a/kernel/sysctl.c b/kernel/sysctl.c
> > index 2cd767b9680eb696efeae06f436548777b1b6844..b589f50d62854985c4c063232c95bd7590434738 100644
> > --- a/kernel/sysctl.c
> > +++ b/kernel/sysctl.c
> > @@ -862,6 +862,22 @@ int proc_doulongvec_minmax(const struct ctl_table *table, int dir,
> >  	return proc_doulongvec_minmax_conv(table, dir, buffer, lenp, ppos, 1l, 1l);
> >  }
> >  
> > +/**
> > + * proc_dointvec_conv - read a vector of ints with a custom converter
> > + * @table: the sysctl table
> > + * @dir: %TRUE if this is a write to the sysctl file
> > + * @buffer: the user buffer
> > + * @lenp: the size of the user buffer
> > + * @ppos: file position
> > + * @conv: Custom converter call back
> > + *
> > + * Reads/writes up to table->maxlen/sizeof(unsigned int) unsigned integer
> > + * values from/to the user buffer, treated as an ASCII string. Negative
> > + * strings are not allowed.
> > + *
> > + * Returns 0 on success
> 
> I think kern-doc expects "Returns:" rather than "Returns". But
They are all like this. Forwarding to linux-doc in case someone wants to
modify all the "Returns" to "Returns:".

Best

> otherwise, yes! :)
> 
> Reviewed-by: Kees Cook <kees@kernel.org>
> 
> -Kees
> 
> > + */
> > +
> >  int proc_dointvec_conv(const struct ctl_table *table, int dir, void *buffer,
> >  		       size_t *lenp, loff_t *ppos,
> >  		       int (*conv)(bool *negp, unsigned long *u_ptr, int *k_ptr,
> > 
> > ---
> > base-commit: 8f0b4cce4481fb22653697cced8d0d04027cb1e8
> > change-id: 20251215-jag-sysctl-doc-d3cb5bd14699
> > 
> > Best regards,
> > -- 
> > Joel Granados <joel.granados@kernel.org>
> > 
> > 
> 
> -- 
> Kees Cook

-- 

Joel Granados

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]