From: "Steven Rostedt (Google)" <rostedt@xxxxxxxxxxx> Man pages only allow at most 9 functions to be described in a single man page. The libtracefs-cpu man page is already at that limit. In order to add more tracefs_cpu_* functions, this needs to be split up. Move the tracefs_cpu_open() and tracefs_cpu_close() functions out into its own man page, to allow more to be added to both. Signed-off-by: Steven Rostedt (Google) <rostedt@xxxxxxxxxxx> --- Documentation/libtracefs-cpu-open.txt | 78 +++++++++++++++++++++++++++ Documentation/libtracefs-cpu.txt | 17 ++---- 2 files changed, 82 insertions(+), 13 deletions(-) create mode 100644 Documentation/libtracefs-cpu-open.txt diff --git a/Documentation/libtracefs-cpu-open.txt b/Documentation/libtracefs-cpu-open.txt new file mode 100644 index 000000000000..58dde508290d --- /dev/null +++ b/Documentation/libtracefs-cpu-open.txt @@ -0,0 +1,78 @@ +libtracefs(3) +============= + +NAME +---- +tracefs_cpu_open, tracefs_cpu_close - Opening trace_pipe_raw data for reading + +SYNOPSIS +-------- +[verse] +-- +*#include <tracefs.h>* + +struct tracefs_cpu pass:[*]*tracefs_cpu_open*(struct tracefs_instance pass:[*]_instance_, + int _cpu_, bool _nonblock_); +void *tracefs_cpu_close*(struct tracefs_cpu pass:[*]_tcpu_); +-- + +DESCRIPTION +----------- +This set of APIs can be used to open the raw data from the trace_pipe_raw +files in the tracefs file system in oder to read them with the *tracefs_cpu_read*(3) +functions. + +The *tracefs_cpu_open()* creates a descriptor that can read the tracefs +trace_pipe_raw file for a given _cpu_ in a given _instance_. If _instance_ is +NULL than the toplevel trace_pipe_raw file is used. + +The *tracefs_cpu_close()* closes all the file descriptors associated to the trace_pipe_raw +opened by *tracefs_cpu_open()*. + +RETURN VALUE +------------ +The *tracefs_cpu_open()* returns a struct tracefs_cpu descriptor that can be +used by the other functions or NULL on error. + +EXAMPLE +------- +See *tracefs_cpu_read*(3) for an example. + +FILES +----- +[verse] +-- +*tracefs.h* + Header file to include in order to have access to the library APIs. +*-ltracefs* + Linker switch to add when building a program that uses the library. +-- + +SEE ALSO +-------- +*libtracefs*(3), +*libtraceevent*(3), +*trace-cmd*(1) + +AUTHOR +------ +[verse] +-- +*Steven Rostedt* <rostedt@xxxxxxxxxxx> +-- +REPORTING BUGS +-------------- +Report bugs to <linux-trace-devel@xxxxxxxxxxxxxxx> + +LICENSE +------- +libtracefs is Free Software licensed under the GNU LGPL 2.1 + +RESOURCES +--------- +https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/ + +COPYING +------- +Copyright \(C) 2022 Google, Inc. Free use of this software is granted under +the terms of the GNU Public License (GPL). diff --git a/Documentation/libtracefs-cpu.txt b/Documentation/libtracefs-cpu.txt index d664ebb3082f..8975e6ec5a0b 100644 --- a/Documentation/libtracefs-cpu.txt +++ b/Documentation/libtracefs-cpu.txt @@ -3,9 +3,8 @@ libtracefs(3) NAME ---- -tracefs_cpu_open, tracefs_cpu_close, tracefs_cpu_read_size, tracefs_cpu_read, -tracefs_cpu_buffered_read, tracefs_cpu_write, tracefs_cpu_stop, tracefs_cpu_flush, -tracefs_cpu_flush_write - Reading trace_pipe_raw data +tracefs_cpu_read_size, tracefs_cpu_read, tracefs_cpu_buffered_read, tracefs_cpu_write, +tracefs_cpu_stop, tracefs_cpu_flush, tracefs_cpu_flush_write - Reading trace_pipe_raw data SYNOPSIS -------- @@ -13,9 +12,6 @@ SYNOPSIS -- *#include <tracefs.h>* -struct tracefs_cpu pass:[*]*tracefs_cpu_open*(struct tracefs_instance pass:[*]_instance_, - int _cpu_, bool _nonblock_); -void *tracefs_cpu_close*(struct tracefs_cpu pass:[*]_tcpu_); int *tracefs_cpu_read_size*(struct tracefs_cpu pass:[*]_tcpu_); int *tracefs_cpu_read*(struct tracefs_cpu pass:[*]_tcpu_, void pass:[*]_buffer_, bool _nonblock_); int *tracefs_cpu_buffered_read*(struct tracefs_cpu pass:[*]_tcpu_, void pass:[*]_buffer_, bool _nonblock_); @@ -30,13 +26,6 @@ DESCRIPTION This set of APIs can be used to read the raw data from the trace_pipe_raw files in the tracefs file system. -The *tracefs_cpu_open()* creates a descriptor that can read the tracefs -trace_pipe_raw file for a given _cpu_ in a given _instance_. If _instance_ is -NULL than the toplevel trace_pipe_raw file is used. - -The *tracefs_cpu_close()* closes all the file descriptors associated to the trace_pipe_raw -opened by *tracefs_cpu_open()*. - The *tracefs_cpu_read_size()* returns the subbuffer size of the trace_pipe_raw. This returns the minimum size of the buffer that is passed to the below functions. @@ -211,6 +200,8 @@ FILES SEE ALSO -------- +*tracefs_cpu_open*(3) +*tracefs_cpu_close*(3) *libtracefs*(3), *libtraceevent*(3), *trace-cmd*(1) -- 2.35.1
|