Skip to content

tools/lib/traceevent: Add man pages for most libtraceevent functions

Steven Rostedt linux-trace-devel lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest27 patches 4 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/27tools lib traceevent: Remove hard coded install paths from pkg-config filetools/lib/traceevent/Makefile tools/lib/traceevent/libtraceevent.pc.template+11 -64 replies
2/27tools/lib/traceevent: Implement libtraceevent man pagestools/lib/traceevent/Documentation/Makefile tools/lib/traceevent/Documentation/asciidoc.conf tools/lib/traceevent/Documentation/libtraceevent.txt +6 more+634 -00 replies
3/27tools/lib/traceevent: Add support for man pages with multiple namestools/lib/traceevent/Documentation/asciidoc.conf+32 -30 replies
4/27tools/lib/traceevent: libtraceevent man pages for tep_handler related APIstools/lib/traceevent/Documentation/libtraceevent-commands.txt tools/lib/traceevent/Documentation/libtraceevent-handle.txt tools/lib/traceevent/Documentation/libtraceevent-long_size.txt +1 more+436 -00 replies
5/27tools/lib/traceevent: Man page for header_page APIstools/lib/traceevent/Documentation/libtraceevent-header_page.txt+102 -00 replies
6/27tools/lib/traceevent: Man page for get/set cpus APIstools/lib/traceevent/Documentation/libtraceevent-cpus.txt+77 -00 replies
7/27tools/lib/traceevent: Man page for file endian APIstools/lib/traceevent/Documentation/libtraceevent-file_endian.txt+91 -00 replies
8/27tools/lib/traceevent: Man page for host endian APIstools/lib/traceevent/Documentation/libtraceevent-host_endian.txt+104 -00 replies
9/27tools/lib/traceevent: Man page for page size APIstools/lib/traceevent/Documentation/libtraceevent-page_size.txt+82 -00 replies
10/27tools/lib/traceevent: Man page for tep_strerror()tools/lib/traceevent/Documentation/libtraceevent-strerror.txt+85 -00 replies
11/27tools/lib/traceevent: Man pages for event handler APIstools/lib/traceevent/Documentation/libtraceevent-reg_event_handler.txt+156 -00 replies
12/27tools/lib/traceevent: Man pages for function related libtraceevent APIstools/lib/traceevent/Documentation/libtraceevent-func_apis.txt tools/lib/traceevent/Documentation/libtraceevent-func_find.txt+271 -00 replies
13/27tools/lib/traceevent: Man pages for registering print functiontools/lib/traceevent/Documentation/libtraceevent-reg_print_func.txt+155 -00 replies
14/27tools/lib/traceevent: Man page for tep_read_number()tools/lib/traceevent/Documentation/libtraceevent-endian_read.txt+78 -00 replies
15/27tools/lib/traceevent: Man pages for event find APIstools/lib/traceevent/Documentation/libtraceevent-event_find.txt+103 -00 replies
16/27tools/lib/traceevent: Man page for list events APIstools/lib/traceevent/Documentation/libtraceevent-event_list.txt+122 -00 replies
17/27tools/lib/traceevent: Man pages for libtraceevent event get APIstools/lib/traceevent/Documentation/libtraceevent-event_get.txt+99 -00 replies
18/27tools/lib/traceevent: Man pages find field APIstools/lib/traceevent/Documentation/libtraceevent-field_find.txt+118 -00 replies
19/27tools/lib/traceevent: Man pages get field value APIstools/lib/traceevent/Documentation/libtraceevent-field_get_val.txt+122 -00 replies
20/27tools/lib/traceevent: Man pages for print field APIstools/lib/traceevent/Documentation/libtraceevent-field_print.txt+126 -00 replies
21/27tools/lib/traceevent: Man page for tep_read_number_field()tools/lib/traceevent/Documentation/libtraceevent-field_read.txt+81 -00 replies
22/27tools/lib/traceevent: Man pages for event fields APIstools/lib/traceevent/Documentation/libtraceevent-fields.txt+105 -00 replies
23/27tools/lib/traceevent: Man pages for event filter APIstools/lib/traceevent/Documentation/libtraceevent-filter.txt+209 -00 replies
24/27tools/lib/traceevent: Man pages for parse event APIstools/lib/traceevent/Documentation/libtraceevent-parse_event.txt+90 -00 replies
25/27tools/lib/traceevent: Man page for tep_parse_header_page()tools/lib/traceevent/Documentation/libtraceevent-parse_head.txt+82 -00 replies
26/27tools/lib/traceevent: Man pages for APIs, used to extract common fields from a recordtools/lib/traceevent/Documentation/libtraceevent-record_parse.txt+137 -00 replies
27/27tools/lib/traceevent: Man pages for trace sequences APIstools/lib/traceevent/Documentation/libtraceevent-tseq.txt+158 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/27] tools/lib/traceevent: Add man pages for most libtraceevent functions

In order to complete the libtraceevent into a proper library, Tzvetomir has been working on creating man pages for all the functions that are exported for use by applications that will use libtraceevent.

In the process of writing these, we came across a few functions that need to be reworked, before we can post libtraceevent for distributions to share. These functions we will be working on and sending patches later on, with corresponding man pages for them. But for now, the man pages in this series are for functions we feel are fine as is.

Arnaldo, please pull these patches into your queue.

Thanks!

-- Steve

Tzvetomir Stoyanov (27):
tools lib traceevent: Remove hard coded install paths from pkg-config file tools/lib/traceevent: Implement libtraceevent man pages tools/lib/traceevent: Add support for man pages with multiple names tools/lib/traceevent: libtraceevent man pages for tep_handler related APIs tools/lib/traceevent: Man page for header_page APIs tools/lib/traceevent: Man page for get/set cpus APIs tools/lib/traceevent: Man page for file endian APIs tools/lib/traceevent: Man page for host endian APIs tools/lib/traceevent: Man page for page size APIs tools/lib/traceevent: Man page for tep_strerror() tools/lib/traceevent: Man pages for event handler APIs tools/lib/traceevent: Man pages for function related libtraceevent APIs tools/lib/traceevent: Man pages for registering print function tools/lib/traceevent: Man page for tep_read_number() tools/lib/traceevent: Man pages for event find APIs tools/lib/traceevent: Man page for list events APIs tools/lib/traceevent: Man pages for libtraceevent event get APIs tools/lib/traceevent: Man pages find field APIs
tools/lib/traceevent: Man pages get field value APIs tools/lib/traceevent: Man pages for print field APIs tools/lib/traceevent: Man page for tep_read_number_field() tools/lib/traceevent: Man pages for event fields APIs tools/lib/traceevent: Man pages for event filter APIs tools/lib/traceevent: Man pages for parse event APIs tools/lib/traceevent: Man page for tep_parse_header_page() tools/lib/traceevent: Man pages for APIs, used to extract common fields from a record tools/lib/traceevent: Man pages for trace sequences APIs

----

 tools/lib/traceevent/Documentation/Makefile        | 207 ++++++++++++++++++++
 tools/lib/traceevent/Documentation/asciidoc.conf   | 120 ++++++++++++
 .../Documentation/libtraceevent-commands.txt       | 153 +++++++++++++++
 .../Documentation/libtraceevent-cpus.txt           |  77 ++++++++
 .../Documentation/libtraceevent-endian_read.txt    |  78 ++++++++
 .../Documentation/libtraceevent-event_find.txt     | 103 ++++++++++
 .../Documentation/libtraceevent-event_get.txt      |  99 ++++++++++
 .../Documentation/libtraceevent-event_list.txt     | 122 ++++++++++++
 .../Documentation/libtraceevent-field_find.txt     | 118 ++++++++++++
 .../Documentation/libtraceevent-field_get_val.txt  | 122 ++++++++++++
 .../Documentation/libtraceevent-field_print.txt    | 126 +++++++++++++
 .../Documentation/libtraceevent-field_read.txt     |  81 ++++++++
 .../Documentation/libtraceevent-fields.txt         | 105 +++++++++++
 .../Documentation/libtraceevent-file_endian.txt    |  91 +++++++++
 .../Documentation/libtraceevent-filter.txt         | 209 +++++++++++++++++++++
 .../Documentation/libtraceevent-func_apis.txt      | 183 ++++++++++++++++++
 .../Documentation/libtraceevent-func_find.txt      |  88 +++++++++
 .../Documentation/libtraceevent-handle.txt         | 101 ++++++++++
 .../Documentation/libtraceevent-header_page.txt    | 102 ++++++++++
 .../Documentation/libtraceevent-host_endian.txt    | 104 ++++++++++
 .../Documentation/libtraceevent-long_size.txt      |  78 ++++++++
 .../Documentation/libtraceevent-page_size.txt      |  82 ++++++++
 .../Documentation/libtraceevent-parse_event.txt    |  90 +++++++++
 .../Documentation/libtraceevent-parse_head.txt     |  82 ++++++++
 .../Documentation/libtraceevent-record_parse.txt   | 137 ++++++++++++++
 .../libtraceevent-reg_event_handler.txt            | 156 +++++++++++++++
 .../Documentation/libtraceevent-reg_print_func.txt | 155 +++++++++++++++
 .../Documentation/libtraceevent-set_flag.txt       | 104 ++++++++++
 .../Documentation/libtraceevent-strerror.txt       |  85 +++++++++
 .../Documentation/libtraceevent-tseq.txt           | 158 ++++++++++++++++
 .../lib/traceevent/Documentation/libtraceevent.txt | 203 ++++++++++++++++++++
 .../lib/traceevent/Documentation/manpage-1.72.xsl  |  14 ++
 .../lib/traceevent/Documentation/manpage-base.xsl  |  35 ++++
 .../Documentation/manpage-bold-literal.xsl         |  17 ++
 .../traceevent/Documentation/manpage-normal.xsl    |  13 ++
 .../Documentation/manpage-suppress-sp.xsl          |  21 +++
 tools/lib/traceevent/Makefile                      |  46 ++++-
 tools/lib/traceevent/libtraceevent.pc.template     |   4 +-
 38 files changed, 3863 insertions(+), 6 deletions(-)
 create mode 100644 tools/lib/traceevent/Documentation/Makefile
 create mode 100644 tools/lib/traceevent/Documentation/asciidoc.conf
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-commands.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-cpus.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-endian_read.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-event_find.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-event_get.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-event_list.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-field_find.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-field_get_val.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-field_print.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-field_read.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-fields.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-file_endian.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-filter.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-func_apis.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-func_find.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-handle.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-header_page.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-host_endian.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-long_size.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-page_size.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-parse_event.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-parse_head.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-record_parse.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-reg_event_handler.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-reg_print_func.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-set_flag.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-strerror.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-tseq.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent.txt
 create mode 100644 tools/lib/traceevent/Documentation/manpage-1.72.xsl
 create mode 100644 tools/lib/traceevent/Documentation/manpage-base.xsl
 create mode 100644 tools/lib/traceevent/Documentation/manpage-bold-literal.xsl
 create mode 100644 tools/lib/traceevent/Documentation/manpage-normal.xsl
 create mode 100644 tools/lib/traceevent/Documentation/manpage-suppress-sp.xsl