All of lore.kernel.org
 help / color / mirror / Atom feed
From: Steven Rostedt <rostedt@goodmis.org>
To: linux-kernel@vger.kernel.org, linux-trace-devel@vger.kernel.org
Cc: Arnaldo Carvalho de Melo <acme@kernel.org>,
	Ingo Molnar <mingo@kernel.org>, Jiri Olsa <jolsa@redhat.com>,
	Namhyung Kim <namhyung@kernel.org>,
	Andrew Morton <akpm@linux-foundation.org>,
	Tzvetomir Stoyanov <tstoyanov@vmware.com>
Subject: [PATCH 00/27] tools/lib/traceevent: Add man pages for most libtraceevent functions
Date: Fri, 10 May 2019 15:56:06 -0400	[thread overview]
Message-ID: <20190510195606.537643615@goodmis.org> (raw)

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

             reply	other threads:[~2019-05-10 20:03 UTC|newest]

Thread overview: 58+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-10 19:56 Steven Rostedt [this message]
2019-05-10 19:56 ` [PATCH 01/27] tools lib traceevent: Remove hard coded install paths from pkg-config file Steven Rostedt
2019-05-10 20:11   ` Steven Rostedt
2019-05-10 21:25     ` Arnaldo Carvalho de Melo
2019-05-14 15:05       ` Arnaldo Carvalho de Melo
2019-05-14 15:49         ` Steven Rostedt
2019-05-10 19:56 ` [PATCH 02/27] tools/lib/traceevent: Implement libtraceevent man pages Steven Rostedt
2019-05-18  9:00   ` [tip:perf/core] tools lib traceevent: Introduce " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 03/27] tools/lib/traceevent: Add support for man pages with multiple names Steven Rostedt
2019-05-18  9:00   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 04/27] tools/lib/traceevent: libtraceevent man pages for tep_handler related APIs Steven Rostedt
2019-05-18  9:01   ` [tip:perf/core] tools lib traceevent: Man " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 05/27] tools/lib/traceevent: Man page for header_page APIs Steven Rostedt
2019-05-18  9:02   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 06/27] tools/lib/traceevent: Man page for get/set cpus APIs Steven Rostedt
2019-05-18  9:02   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 07/27] tools/lib/traceevent: Man page for file endian APIs Steven Rostedt
2019-05-18  9:03   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 08/27] tools/lib/traceevent: Man page for host " Steven Rostedt
2019-05-18  9:04   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 09/27] tools/lib/traceevent: Man page for page size APIs Steven Rostedt
2019-05-18  9:05   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 10/27] tools/lib/traceevent: Man page for tep_strerror() Steven Rostedt
2019-05-18  9:05   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 11/27] tools/lib/traceevent: Man pages for event handler APIs Steven Rostedt
2019-05-18  9:06   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 12/27] tools/lib/traceevent: Man pages for function related libtraceevent APIs Steven Rostedt
2019-05-18  9:07   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 13/27] tools/lib/traceevent: Man pages for registering print function Steven Rostedt
2019-05-18  9:08   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 14/27] tools/lib/traceevent: Man page for tep_read_number() Steven Rostedt
2019-05-18  9:08   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 15/27] tools/lib/traceevent: Man pages for event find APIs Steven Rostedt
2019-05-18  9:09   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 16/27] tools/lib/traceevent: Man page for list events APIs Steven Rostedt
2019-05-18  9:10   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 17/27] tools/lib/traceevent: Man pages for libtraceevent event get APIs Steven Rostedt
2019-05-18  9:10   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 18/27] tools/lib/traceevent: Man pages find field APIs Steven Rostedt
2019-05-18  9:11   ` [tip:perf/core] tools lib traceevent: Man pages for " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 19/27] tools/lib/traceevent: Man pages get field value APIs Steven Rostedt
2019-05-18  9:12   ` [tip:perf/core] tools lib traceevent: Man pages for " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 20/27] tools/lib/traceevent: Man pages for print field APIs Steven Rostedt
2019-05-18  9:13   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 21/27] tools/lib/traceevent: Man page for tep_read_number_field() Steven Rostedt
2019-05-18  9:13   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 22/27] tools/lib/traceevent: Man pages for event fields APIs Steven Rostedt
2019-05-18  9:14   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 23/27] tools/lib/traceevent: Man pages for event filter APIs Steven Rostedt
2019-05-18  9:15   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 24/27] tools/lib/traceevent: Man pages for parse event APIs Steven Rostedt
2019-05-18  9:16   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 25/27] tools/lib/traceevent: Man page for tep_parse_header_page() Steven Rostedt
2019-05-18  9:16   ` [tip:perf/core] tools lib traceevent: " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 26/27] tools/lib/traceevent: Man pages for APIs, used to extract common fields from a record Steven Rostedt
2019-05-18  9:17   ` [tip:perf/core] tools lib traceevent: Man pages for APIs " tip-bot for Tzvetomir Stoyanov
2019-05-10 19:56 ` [PATCH 27/27] tools/lib/traceevent: Man pages for trace sequences APIs Steven Rostedt
2019-05-18  9:18   ` [tip:perf/core] tools lib traceevent: " tip-bot for 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=20190510195606.537643615@goodmis.org \
    --to=rostedt@goodmis.org \
    --cc=acme@kernel.org \
    --cc=akpm@linux-foundation.org \
    --cc=jolsa@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=namhyung@kernel.org \
    --cc=tstoyanov@vmware.com \
    /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.