From: Tzvetomir Stoyanov <tstoyanov@vmware.com>
To: "rostedt@goodmis.org" <rostedt@goodmis.org>
Cc: "linux-trace-devel@vger.kernel.org" <linux-trace-devel@vger.kernel.org>
Subject: [PATCH 2/7] tools/lib/traceevent: Implement libtraceevent man pages
Date: Tue, 6 Nov 2018 13:20:51 +0000 [thread overview]
Message-ID: <20181106132035.7692-3-tstoyanov@vmware.com> (raw)
In-Reply-To: <20181106132035.7692-1-tstoyanov@vmware.com>
This patch implements a man page, which documents
tep_get_cpus() and tep_set_cpus() 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..f9ed0a02d653
--- /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 numbers 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()_ functions gets the number of CPUs, which have tracing
+data recorded. The _tep_ argument is trace event parser context.
+
+The _tep_set_cpus()_ functions 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. This information is saved
+in the trace.dat file.
+
+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
--
2.17.2
next prev parent reply other threads:[~2018-11-06 22:46 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-11-06 13:20 [PATCH 0/7] libtracevent man pages Tzvetomir Stoyanov
2018-11-06 13:20 ` [PATCH 1/7] tools/lib/traceevent: Implement libtraceevent " Tzvetomir Stoyanov
2018-11-06 13:20 ` Tzvetomir Stoyanov [this message]
2018-11-07 0:07 ` [PATCH 2/7] " Steven Rostedt
2018-11-06 13:20 ` [PATCH 3/7] " Tzvetomir Stoyanov
2018-11-07 0:14 ` Steven Rostedt
2018-11-06 13:20 ` [PATCH 4/7] " Tzvetomir Stoyanov
2018-11-07 0:15 ` Steven Rostedt
2018-11-07 14:45 ` Tzvetomir Stoyanov
2018-11-06 13:20 ` [PATCH 5/7] " Tzvetomir Stoyanov
2018-11-07 0:19 ` Steven Rostedt
2018-11-06 13:20 ` [PATCH 6/7] " Tzvetomir Stoyanov
2018-11-07 0:23 ` Steven Rostedt
2018-11-06 13:20 ` [PATCH 7/7] " Tzvetomir Stoyanov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20181106132035.7692-3-tstoyanov@vmware.com \
--to=tstoyanov@vmware.com \
--cc=linux-trace-devel@vger.kernel.org \
--cc=rostedt@goodmis.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).