]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
sysctl: Add missing kernel-doc for proc_dointvec_conv
authorJoel Granados <joel.granados@kernel.org>
Thu, 4 Dec 2025 12:36:57 +0000 (13:36 +0100)
committerJoel Granados <joel.granados@kernel.org>
Mon, 5 Jan 2026 12:36:45 +0000 (13:36 +0100)
Add kernel-doc documentation for the proc_dointvec_conv function to
describe its parameters and return value.

Reviewed-by: Kees Cook <kees@kernel.org>
Signed-off-by: Joel Granados <joel.granados@kernel.org>
kernel/sysctl.c

index 2cd767b9680eb696efeae06f436548777b1b6844..ae937c1b527262c2ccfe15786d6cb77853d1c867 100644 (file)
@@ -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,