mbox series

[0/9] libtraceevent: Add checks for man pages

Message ID 20220922152510.3335601-1-rostedt@goodmis.org (mailing list archive)
Headers show
Series libtraceevent: Add checks for man pages | expand

Message

Steven Rostedt Sept. 22, 2022, 3:25 p.m. UTC 
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