From: Steven Rostedt <rostedt@goodmis.org>
To: linux-trace-devel@vger.kernel.org
Cc: "Steven Rostedt (Google)" <rostedt@goodmis.org>
Subject: [PATCH 0/9] libtraceevent: Add checks for man pages
Date: Thu, 22 Sep 2022 11:25:01 -0400 [thread overview]
Message-ID: <20220922152510.3335601-1-rostedt@goodmis.org> (raw)
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
Add the check code from libtracefs that makes sure every function in
event-parse.h is documented in man pages, and that every man page entry is
listed in the top level libtraceevent man page.
Steven Rostedt (Google) (9):
libtraceevent: Add check-manpages.sh
libtraceevent: Update man page to reflect tep_is_pid_registered()
rename
libtraceevent: Add printk documentation to libtraceevent man page
libtraceevent: Add tep_get_function_count() to libtraceevent man page
libtraceevent: Include meta data functions in libtraceevent man pages
libtraceevent: Add some missing functions to generic libtraceevent man
page
libtraceevent: Add man page for tep_plugin_add_option()
libtraceevent: Add man page documentation of tep_get_sub_buffer_size()
libtraceevent: Add tep_print_field() to check-manpages.sh deprecated
Documentation/libtraceevent-commands.txt | 2 +-
Documentation/libtraceevent-page_size.txt | 10 ++++-
Documentation/libtraceevent-plugins.txt | 9 +++-
Documentation/libtraceevent.txt | 22 +++++++++
Makefile | 5 ++-
check-manpages.sh | 54 +++++++++++++++++++++++
6 files changed, 98 insertions(+), 4 deletions(-)
create mode 100755 check-manpages.sh
--
2.35.1
next reply other threads:[~2022-09-22 15:24 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-22 15:25 Steven Rostedt [this message]
2022-09-22 15:25 ` [PATCH 1/9] libtraceevent: Add check-manpages.sh Steven Rostedt
2022-09-22 15:25 ` [PATCH 2/9] libtraceevent: Update man page to reflect tep_is_pid_registered() rename Steven Rostedt
2022-09-22 15:25 ` [PATCH 3/9] libtraceevent: Add printk documentation to libtraceevent man page Steven Rostedt
2022-09-22 15:25 ` [PATCH 4/9] libtraceevent: Add tep_get_function_count() " Steven Rostedt
2022-09-22 15:25 ` [PATCH 5/9] libtraceevent: Include meta data functions in libtraceevent man pages Steven Rostedt
2022-09-22 15:25 ` [PATCH 6/9] libtraceevent: Add some missing functions to generic libtraceevent man page Steven Rostedt
2022-09-22 15:25 ` [PATCH 7/9] libtraceevent: Add man page for tep_plugin_add_option() Steven Rostedt
2022-09-22 15:25 ` [PATCH 8/9] libtraceevent: Add man page documentation of tep_get_sub_buffer_size() Steven Rostedt
2022-09-22 15:25 ` [PATCH 9/9] libtraceevent: Add tep_print_field() to check-manpages.sh deprecated Steven Rostedt
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=20220922152510.3335601-1-rostedt@goodmis.org \
--to=rostedt@goodmis.org \
--cc=linux-trace-devel@vger.kernel.org \
/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.