[dpdk-dev] [PATCH v2 0/4] provide man pages for binaries provided by DPDK

Christian Ehrhardt christian.ehrhardt at canonical.com
Wed Aug 31 09:50:08 CEST 2016


*Updates in v2*
- rebased to latest upstream
- moved tools to their own guide section
- fixed some wording and indents
- properly marked fixed-width text elements
- fixed some rst issues in devbind doc

Hi,
this is about providing manpages for the binaries installed by DPDK.
Eventually people using commands expect at least something reasonable avalable
behind "man command".

Still it is a try to stick to the rst/sphinx based doc creation.
I found that for three of the 5 binaries that are usually installed the current
rst files are sufficient to make a meaningful man page:
- testpmd
- dpdk-pdump
- dpd-procinfo

To be clear, this is only meant for the binaries installed by DPDK,
there is no reason to render all the guides and howto's as one huge manpage.
Also this series doesn't strive to render the api doc as man pages,
while this certainly might be possible and even reasonable for section
"3   Library calls (functions within program libraries)".

Finally I must beg a pardon - I'm no makefile magician and sometimes even prefer
things that work compared to long cryptic lines with many special chars.
Yet if someone has something reasonable to unify the copy&paste in patch #4
please let me know.

Christian Ehrhardt (4):
  doc: move tool guides in their own subdirectory
  doc: rendering and installation of man pages
  doc: add basic invocation info for dpdk-pmdinfo
  doc: add basic invocation info for dpdk-devbind

 doc/guides/conf.py                     |  12 +++
 doc/guides/index.rst                   |   1 +
 doc/guides/sample_app_ug/index.rst     |   2 -
 doc/guides/sample_app_ug/pdump.rst     | 144 ---------------------------------
 doc/guides/sample_app_ug/proc_info.rst |  71 ----------------
 doc/guides/tools/devbind.rst           | 143 ++++++++++++++++++++++++++++++++
 doc/guides/tools/index.rst             |  42 ++++++++++
 doc/guides/tools/pdump.rst             | 144 +++++++++++++++++++++++++++++++++
 doc/guides/tools/pmdinfo.rst           |  57 +++++++++++++
 doc/guides/tools/proc_info.rst         |  71 ++++++++++++++++
 mk/rte.sdkdoc.mk                       |   2 +-
 mk/rte.sdkinstall.mk                   |  11 +++
 12 files changed, 482 insertions(+), 218 deletions(-)
 delete mode 100644 doc/guides/sample_app_ug/pdump.rst
 delete mode 100644 doc/guides/sample_app_ug/proc_info.rst
 create mode 100644 doc/guides/tools/devbind.rst
 create mode 100644 doc/guides/tools/index.rst
 create mode 100644 doc/guides/tools/pdump.rst
 create mode 100644 doc/guides/tools/pmdinfo.rst
 create mode 100644 doc/guides/tools/proc_info.rst

-- 
2.7.4



More information about the dev mailing list