[v2,00/10] Man pages for libtraceevent

Message

Tzvetomir Stoyanov Nov. 9, 2018, 1:31 p.m. UTC

This patch series implements libtraceveent man pages,
describing APIs: tep_register_comm,tep_pid_is_registered,
tep_data_comm_from_pid,tep_data_pid_from_comm,tep_cmdline_pid,
tep_alloc,tep_free,tep_get_long_size,tep_set_long_size,
tep_set_flag,tep_get_header_page_size, tep_get_cpus, tep_set_cpus,
tep_is_file_bigendian, tep_set_file_bigendian,
tep_is_host_bigendian, tep_set_host_bigendian,
tep_is_latency_format, and tep_set_latency_format,
tep_get_page_size, tep_set_page_size and tep_strerror.
It also fixes asciidoc.conf to support man pages with multiple names,
used to combine the description of several APIs into one page.

Tzvetomir Stoyanov (11):
  tools/lib/traceevent: Fix libtraceevent/Documentation Makefile
  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 tep_get_header_page_size()
  tools/lib/traceevent: Man page for tep_get_cpus() and tep_set_cpus()
  tools/lib/traceevent: Man page for tep_is_file_bigendian() and
    tep_set_file_bigendian()
  tools/lib/traceevent: Man page for tep_is_host_bigendian() and
    tep_set_host_bigendian()
  tools/lib/traceevent: Man page for tep_is_latency_format() and
    tep_set_latency_format()
  tools/lib/traceevent: Man page for tep_get_page_size() and
    tep_set_page_size()
  tools/lib/traceevent: Man page for tep_strerror()

 tools/lib/traceevent/Documentation/Makefile   |   5 +-
 .../traceevent/Documentation/asciidoc.conf    |  35 ++++-
 .../Documentation/libtraceevent-commands.txt  | 130 ++++++++++++++++++
 .../Documentation/libtraceevent-cpus.txt      |  78 +++++++++++
 .../libtraceevent-file_endian.txt             |  89 ++++++++++++
 .../Documentation/libtraceevent-handle.txt    | 101 ++++++++++++++
 .../libtraceevent-header_size.txt             |  73 ++++++++++
 .../libtraceevent-host_endian.txt             |  90 ++++++++++++
 .../libtraceevent-latency_format.txt          | 100 ++++++++++++++
 .../Documentation/libtraceevent-long_size.txt |  79 +++++++++++
 .../Documentation/libtraceevent-page_size.txt |  80 +++++++++++
 .../Documentation/libtraceevent-set_flag.txt  |  94 +++++++++++++
 .../Documentation/libtraceevent-strerror.txt  |  78 +++++++++++
 tools/lib/traceevent/event-parse-api.c        |  31 +++--
 14 files changed, 1123 insertions(+), 103 deletions(-)
 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-file_endian.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-handle.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-header_size.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-set_flag.txt
 create mode 100644 tools/lib/traceevent/Documentation/libtraceevent-strerror.txt