mbox series

[00/11] libtracefs: Add man page checks and upate man pages

Message ID 20220223003012.1334741-1-rostedt@goodmis.org (mailing list archive)
Headers show
Series libtracefs: Add man page checks and upate man pages | expand

Message

Steven Rostedt Feb. 23, 2022, 12:30 a.m. UTC 
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>

In preperation to release libtracefs 1.3, the man pages need to be complete.

I sent a patch to add a check-manpage.sh which this series is based on:

   https://lore.kernel.org/all/20220222131816.0bfdb33e@gandalf.local.home/

This series fixes the man page issues that the script has found. It also
updates the script to check tracefs.h to see if there's any missing functions
that should be in the man pages.

This series fixes the missing functions from the man pages too.

Finally, to make sure that functions are not missed in the future, the script
is executed whenever "make doc" is performed.

Steven Rostedt (Google) (11):
  libtracefs: Update main man page for all functions
  libtracefs: Do not check libtracefs-options.txt man page
  libtracefs: Have check-manpages.sh check tracefs.h as well
  libtracefs: Add documentation for tracefs_instances()
  libtracefs: Hide tracefs_list_pop() and make it trace_list_pop()
  libtracefs: Add documentation for tracefs_list_add/size()
  libtracefs: Add documentation for tracefs_iterate_stop()
  libtracefs: Add documentation for tracefs_option_id()
  libtracefs: Add man pages for tracefs_event_file_*() functions
  libtracefs: Do not check for deprecated functions
  libtracefs: Run the check-manpages.sh on building of docs

 Documentation/libtracefs-events-file.txt      | 217 ++++++++++++++++++
 Documentation/libtracefs-events.txt           |   9 +-
 .../libtracefs-instances-affinity.txt         |   4 +-
 Documentation/libtracefs-instances-manage.txt |  14 +-
 Documentation/libtracefs-option-get.txt       |  11 +-
 Documentation/libtracefs-utils.txt            |  28 ++-
 Documentation/libtracefs.txt                  |  33 +++
 Makefile                                      |   5 +-
 check-manpages.sh                             |  22 ++
 include/tracefs-local.h                       |   1 +
 include/tracefs.h                             |   1 -
 src/tracefs-hist.c                            |  10 +-
 src/tracefs-utils.c                           |   6 +-
 13 files changed, 342 insertions(+), 19 deletions(-)
 create mode 100644 Documentation/libtracefs-events-file.txt