[PATCH 28/73] tools lib traceevent: Man page for page size APIs

From: Arnaldo Carvalho de Melo
Date: Fri May 17 2019 - 15:40:37 EST

From: Tzvetomir Stoyanov <tstoyanov@xxxxxxxxxx>

Create man pages for libtraceevent APIs:


Signed-off-by: Tzvetomir Stoyanov <tstoyanov@xxxxxxxxxx>
Cc: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
Cc: Jiri Olsa <jolsa@xxxxxxxxxx>
Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
Cc: linux-trace-devel@xxxxxxxxxxxxxxx
Link: http://lore.kernel.org/linux-trace-devel/20190503091119.23399-9-tstoyanov@xxxxxxxxxx
Link: http://lkml.kernel.org/r/20190510200107.218173559@xxxxxxxxxxx
Signed-off-by: Steven Rostedt (VMware) <rostedt@xxxxxxxxxxx>
Signed-off-by: Arnaldo Carvalho de Melo <acme@xxxxxxxxxx>
.../Documentation/libtraceevent-page_size.txt | 82 +++++++++++++++++++
1 file changed, 82 insertions(+)
create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-page_size.txt

diff --git a/tools/lib/traceevent/Documentation/libtraceevent-page_size.txt b/tools/lib/traceevent/Documentation/libtraceevent-page_size.txt
new file mode 100644
index 000000000000..452c0cfa1822
--- /dev/null
+++ b/tools/lib/traceevent/Documentation/libtraceevent-page_size.txt
@@ -0,0 +1,82 @@
+tep_get_page_size, tep_set_page_size - Get / set the size of a memory page on
+the machine, where the trace is generated
+*#include <event-parse.h>*
+int *tep_get_page_size*(struct tep_handle pass:[*]_tep_);
+void *tep_set_page_size*(struct tep_handle pass:[*]_tep_, int _page_size_);
+The _tep_get_page_size()_ function returns the size of a memory page on
+the machine, where the trace is generated. The _tep_ argument is trace
+event parser context.
+The _tep_set_page_size()_ function stores in the _tep_ context the size of a
+memory page on the machine, where the trace is generated.
+The _tep_ argument is trace event parser context.
+The _page_size_ argument is the size of a memory page, in bytes.
+The _tep_get_page_size()_ function returns size of the memory page, in bytes.
+#include <unistd.h>
+#include <event-parse.h>
+struct tep_handle *tep = tep_alloc();
+ int page_size = getpagesize();
+ tep_set_page_size(tep, page_size);
+ printf("The page size for this machine is %d\n", tep_get_page_size(tep));
+ Header file to include in order to have access to the library APIs.
+ Linker switch to add when building a program that uses the library.
+_libtraceevent(3)_, _trace-cmd(1)_
+*Steven Rostedt* <rostedt@xxxxxxxxxxx>, author of *libtraceevent*.
+*Tzvetomir Stoyanov* <tz.stoyanov@xxxxxxxxx>, author of this man page.
+Report bugs to <linux-trace-devel@xxxxxxxxxxxxxxx>
+libtraceevent is Free Software licensed under the GNU LGPL 2.1