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 1/7] tools/lib/traceevent: Implement libtraceevent man pages
Date: Tue, 6 Nov 2018 13:20:50 +0000 [thread overview]
Message-ID: <20181106132035.7692-2-tstoyanov@vmware.com> (raw)
In-Reply-To: <20181106132035.7692-1-tstoyanov@vmware.com>
This patch implements a man page, which documents
tep_get_header_page_size() libtraceevent API
Signed-off-by: Tzvetomir Stoyanov <tstoyanov@vmware.com>
---
| 73 +++++++++++++++++++
tools/lib/traceevent/event-parse-api.c | 4 +-
2 files changed, 75 insertions(+), 2 deletions(-)
create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-header_size.txt
--git a/tools/lib/traceevent/Documentation/libtraceevent-header_size.txt b/tools/lib/traceevent/Documentation/libtraceevent-header_size.txt
new file mode 100644
index 000000000000..8edf49d2a709
--- /dev/null
+++ b/tools/lib/traceevent/Documentation/libtraceevent-header_size.txt
@@ -0,0 +1,73 @@
+libtraceevent(3)
+================
+
+NAME
+----
+tep_get_header_page_size - Get the size of a long integer, in kernel context.
+
+SYNOPSIS
+--------
+[verse]
+--
+*#include <event-parse.h>*
+
+int *tep_get_header_page_size*(struct tep_handle pass:[*]_tep_);
+
+--
+DESCRIPTION
+-----------
+The _tep_get_header_page_size()_ function returns the size of a long integer,
+in kernel context. The _tep_ argument is trace event parser context.
+This information is retrieved from /sys/kernel/debug/tracing/events/header_page,
+ "commit" field.
+
+RETURN VALUE
+------------
+The _tep_get_header_page_size()_ function returns the size of a long integer,
+in bytes
+
+EXAMPLE
+-------
+[source,c]
+--
+#include <event-parse.h>
+...
+struct tep_handle *tep = tep_alloc();
+...
+ int lsize = tep_get_header_page_size(tep);
+ printf ("The size of a long in kernel context is %d bytes", lsize);
+...
+--
+
+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
diff --git a/tools/lib/traceevent/event-parse-api.c b/tools/lib/traceevent/event-parse-api.c
index 6a1899b378b1..39e0fca2d9a2 100644
--- a/tools/lib/traceevent/event-parse-api.c
+++ b/tools/lib/traceevent/event-parse-api.c
@@ -100,10 +100,10 @@ tep_data2host8(struct tep_handle *pevent, unsigned long long data)
}
/**
- * tep_get_header_page_size - get size of the header page
+ * tep_get_header_page_size - get the size of a long integer, in kernel context
* @pevent: a handle to the tep_handle
*
- * This returns size of the header page
+ * This returns the size of a long integer, in kernel context
* If @pevent is NULL, 0 is returned.
*/
int tep_get_header_page_size(struct tep_handle *pevent)
--
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 ` Tzvetomir Stoyanov [this message]
2018-11-06 13:20 ` [PATCH 2/7] tools/lib/traceevent: Implement libtraceevent " Tzvetomir Stoyanov
2018-11-07 0:07 ` 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-2-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.