[v2,15/22] libtracefs: Add kerneldoc comments to tracefs_instance_set_buffer_size()

Commit Message

Steven Rostedt Dec. 28, 2023, 9:52 p.m. UTC

From: "Steven Rostedt (Google)" <[e-mail]>

When the API tracefs_instance_set_buffer_size() was added, the kerneldoc
associated to it was not.

Signed-off-by: Steven Rostedt (Google) <[e-mail]>
---
 src/tracefs-instance.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

Patch

diff --git a/src/tracefs-instance.c b/src/tracefs-instance.c
index 4e7434157109..2162424ad3a7 100644
--- a/src/tracefs-instance.c
+++ b/src/tracefs-instance.c
@@ -402,6 +402,18 @@  ssize_t tracefs_instance_get_buffer_size(struct tracefs_instance *instance, int
 	return size;
 }
 
+/**
+ * tracefs_instance_set_buffer_size - modify the ring buffer size
+ * @instance: The instance to modify (NULL for the top level)
+ * @size: The size in kilobytes to to set the size to
+ * @cpu: the CPU to set it to (-1 for all CPUs)
+ *
+ * Sets the size of the ring buffer per CPU buffers. If @cpu is negative,
+ * then it sets the ring buffer size for all the per CPU buffers, otherwise
+ * it only sets the per CPU buffer specified by @cpu.
+ *
+ * Returns 0 on success and -1 on error.
+ */
 int tracefs_instance_set_buffer_size(struct tracefs_instance *instance, size_t size, int cpu)
 {
 	char *path;