[v3,07/46] tools/lib/traceevent: Man page for tep_get_cpus() and tep_set_cpus()
diff mbox series

Message ID 20181127154153.11315-8-tstoyanov@vmware.com
State Superseded
Headers show
Series
  • Libtraceevent MAN pages
Related show

Commit Message

Tzvetomir Stoyanov Nov. 27, 2018, 3:42 p.m. UTC
Create man pages for tep_get_cpus() and tep_set_cpus() as part of the
libtraceevent APIs.

Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com>
---
 .../Documentation/libtraceevent-cpus.txt      | 78 +++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-cpus.txt

Comments

Steven Rostedt Jan. 16, 2019, 4:32 p.m. UTC | #1
On Tue, 27 Nov 2018 15:42:15 +0000
Tzvetomir Stoyanov <tstoyanov@vmware.com> wrote:

> Create man pages for tep_get_cpus() and tep_set_cpus() as part of the
> libtraceevent APIs.
> 
> Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com>
> ---
>  .../Documentation/libtraceevent-cpus.txt      | 78 +++++++++++++++++++
>  1 file changed, 78 insertions(+)
>  create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-cpus.txt
> 
> diff --git a/tools/lib/traceevent/Documentation/libtraceevent-cpus.txt b/tools/lib/traceevent/Documentation/libtraceevent-cpus.txt
> new file mode 100644
> index 000000000000..81d9b4c83bee
> --- /dev/null
> +++ b/tools/lib/traceevent/Documentation/libtraceevent-cpus.txt
> @@ -0,0 +1,78 @@
> +libtraceevent(3)
> +================
> +
> +NAME
> +----
> +tep_get_cpus,tep_set_cpus - Get / set the number of CPUs, which have tracing 
> +data recorded.

A better way to say this is:

"which have a tracing buffer representing it. Note, the buffer may be
empty".

That's because the way it is currently written sounds like empty
buffers wont be counted.

> +
> +SYNOPSIS
> +--------
> +[verse]
> +--
> +*#include <event-parse.h>*
> +
> +int *tep_get_cpus*(struct tep_handle pass:[*]_tep_);
> +void *tep_set_cpus*(struct tep_handle pass:[*]_tep_, int _cpus_);
> +--
> +
> +DESCRIPTION
> +-----------
> +The _tep_get_cpus()_ function gets the number of CPUs, which have tracing 
> +data recorded in the _tep_ context. The _tep_ argument is trace event parser 
> +context.
> +
> +The _tep_set_cpus()_ function sets the number of CPUs, which have tracing 
> +data recorded. The _tep_ argument is trace event parser context. The _cpu_
> +argument is the number of CPUs with tracing data.

Update these too.

Thanks!

(also make sure the next patch is run through checkpatch to make sure
it doesn't have any whitespace errors).

-- Steve

> +
> +RETURN VALUE
> +------------
> +The _tep_get_cpus()_ functions returns the number of CPUs, which have tracing 
> +data recorded.
> +
> +EXAMPLE
> +-------
> +[source,c]
> +--
> +#include <event-parse.h>
> +...
> +struct tep_handle *tep = tep_alloc();
> +...
> +	tep_set_cpus(tep, 5);
> +...
> +	printf("We have tracing data for %d CPUs", tep_get_cpus(tep));
> +--
> +
> +FILES
> +-----
> +[verse]
> +--
> +*event-parse.h*
> +	Header file to include in order to have access to the library APIs.
> +*-ltraceevent*
> +	Linker switch to add when building a program that uses the library.
> +--
> +
> +SEE ALSO
> +--------
> +_libtraceevent(3)_, _trace-cmd(1)_
> +
> +AUTHOR
> +------
> +[verse]
> +--
> +*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
> +*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
> +--
> +REPORTING BUGS
> +--------------
> +Report bugs to  <linux-trace-devel@vger.kernel.org>
> +
> +LICENSE
> +-------
> +libtraceevent is Free Software licensed under the GNU LGPL 2.1
> +
> +RESOURCES
> +---------
> +https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git

Patch
diff mbox series

diff --git a/tools/lib/traceevent/Documentation/libtraceevent-cpus.txt b/tools/lib/traceevent/Documentation/libtraceevent-cpus.txt
new file mode 100644
index 000000000000..81d9b4c83bee
--- /dev/null
+++ b/tools/lib/traceevent/Documentation/libtraceevent-cpus.txt
@@ -0,0 +1,78 @@ 
+libtraceevent(3)
+================
+
+NAME
+----
+tep_get_cpus,tep_set_cpus - Get / set the number of CPUs, which have tracing 
+data recorded.
+
+SYNOPSIS
+--------
+[verse]
+--
+*#include <event-parse.h>*
+
+int *tep_get_cpus*(struct tep_handle pass:[*]_tep_);
+void *tep_set_cpus*(struct tep_handle pass:[*]_tep_, int _cpus_);
+--
+
+DESCRIPTION
+-----------
+The _tep_get_cpus()_ function gets the number of CPUs, which have tracing 
+data recorded in the _tep_ context. The _tep_ argument is trace event parser 
+context.
+
+The _tep_set_cpus()_ function sets the number of CPUs, which have tracing 
+data recorded. The _tep_ argument is trace event parser context. The _cpu_
+argument is the number of CPUs with tracing data.
+
+RETURN VALUE
+------------
+The _tep_get_cpus()_ functions returns the number of CPUs, which have tracing 
+data recorded.
+
+EXAMPLE
+-------
+[source,c]
+--
+#include <event-parse.h>
+...
+struct tep_handle *tep = tep_alloc();
+...
+	tep_set_cpus(tep, 5);
+...
+	printf("We have tracing data for %d CPUs", tep_get_cpus(tep));
+--
+
+FILES
+-----
+[verse]
+--
+*event-parse.h*
+	Header file to include in order to have access to the library APIs.
+*-ltraceevent*
+	Linker switch to add when building a program that uses the library.
+--
+
+SEE ALSO
+--------
+_libtraceevent(3)_, _trace-cmd(1)_
+
+AUTHOR
+------
+[verse]
+--
+*Steven Rostedt* <rostedt@goodmis.org>, author of *libtraceevent*.
+*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
+--
+REPORTING BUGS
+--------------
+Report bugs to  <linux-trace-devel@vger.kernel.org>
+
+LICENSE
+-------
+libtraceevent is Free Software licensed under the GNU LGPL 2.1
+
+RESOURCES
+---------
+https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git