[PATCH 5/7] sysctl: Add kernel doc to proc_douintvec_conv

Joel Granados posted 7 patches 1 month, 3 weeks ago
[PATCH 5/7] sysctl: Add kernel doc to proc_douintvec_conv
Posted by Joel Granados 1 month, 3 weeks ago
This commit is making sure that all the functions that are part of the
API are documented.

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 5901196a52f98cdd5aba4f50899a58d9bd9d10f9..ed2701acc89821e724b5697665f8a795dff8097d 100644
--- a/kernel/sysctl.c
+++ b/kernel/sysctl.c
@@ -656,6 +656,22 @@ static int do_proc_douintvec(const struct ctl_table *table, int dir,
 	return do_proc_douintvec_r(table, buffer, lenp, ppos, conv);
 }
 
+/**
+ * proc_douintvec_conv - read a vector of unsigned 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_douintvec_conv(const struct ctl_table *table, int dir, void *buffer,
 			size_t *lenp, loff_t *ppos,
 			int (*conv)(unsigned long *u_ptr, unsigned int *k_ptr,

-- 
2.50.1