[
v5 changes:
- Grouped logically related APIs into single man page.
- Updated the man pages, to be in sync with the latest libtracevent APIs cleanup.
- Changed descriptions in some man pages, suggested by Steven Rostedt.
v4 changes:
- Addressed Steven Rostedt comments.
- Removed trailing whitespace.
v3 changes:
- Combines all man page related patches into one series.
- Removes any dependencies between man page related patches.
and patches related to the APIs implementation.
]
This patch series includes implementation of libtraceevent
man pages, describing all APIs of the library.
Tzvetomir Stoyanov (30):
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 page for tep_register_trace_clock()
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 print related
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 tep plugins APIs
tools/lib/traceevent: Man pages for "latency format" APIs
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 | 208 +++++++++++++++++
.../traceevent/Documentation/asciidoc.conf | 120 ++++++++++
.../Documentation/libtraceevent-commands.txt | 153 +++++++++++++
.../Documentation/libtraceevent-cpus.txt | 77 +++++++
.../libtraceevent-endian_read.txt | 78 +++++++
.../libtraceevent-event_find.txt | 101 +++++++++
.../Documentation/libtraceevent-event_get.txt | 99 +++++++++
.../libtraceevent-event_list.txt | 121 ++++++++++
.../libtraceevent-event_print.txt | 138 ++++++++++++
.../libtraceevent-field_find.txt | 118 ++++++++++
.../libtraceevent-field_get_val.txt | 121 ++++++++++
.../libtraceevent-field_print.txt | 121 ++++++++++
.../libtraceevent-field_read.txt | 80 +++++++
.../Documentation/libtraceevent-fields.txt | 105 +++++++++
.../libtraceevent-file_endian.txt | 91 ++++++++
.../Documentation/libtraceevent-filter.txt | 210 ++++++++++++++++++
.../Documentation/libtraceevent-func_apis.txt | 175 +++++++++++++++
.../Documentation/libtraceevent-func_find.txt | 88 ++++++++
.../Documentation/libtraceevent-handle.txt | 101 +++++++++
.../libtraceevent-header_page.txt | 105 +++++++++
.../libtraceevent-host_endian.txt | 106 +++++++++
.../libtraceevent-latency_format.txt | 154 +++++++++++++
.../Documentation/libtraceevent-long_size.txt | 78 +++++++
.../Documentation/libtraceevent-page_size.txt | 80 +++++++
.../libtraceevent-parse_event.txt | 90 ++++++++
.../libtraceevent-parse_head.txt | 82 +++++++
.../Documentation/libtraceevent-plugins.txt | 98 ++++++++
.../libtraceevent-record_parse.txt | 137 ++++++++++++
.../Documentation/libtraceevent-reg_clock.txt | 77 +++++++
.../libtraceevent-reg_event_handler.txt | 131 +++++++++++
.../libtraceevent-reg_print_func.txt | 155 +++++++++++++
.../Documentation/libtraceevent-set_flag.txt | 104 +++++++++
.../Documentation/libtraceevent-strerror.txt | 80 +++++++
.../Documentation/libtraceevent-tseq.txt | 158 +++++++++++++
.../Documentation/libtraceevent.txt | 203 +++++++++++++++++
.../traceevent/Documentation/manpage-1.72.xsl | 14 ++
.../traceevent/Documentation/manpage-base.xsl | 35 +++
.../Documentation/manpage-bold-literal.xsl | 17 ++
.../Documentation/manpage-normal.xsl | 13 ++
.../Documentation/manpage-suppress-sp.xsl | 21 ++
tools/lib/traceevent/Makefile | 33 +++
41 files changed, 4276 insertions(+)
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-event_print.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-latency_format.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-plugins.txt
create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-record_parse.txt
create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-reg_clock.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
--
2.20.1
|