From: Luca Boccassi <lboccass@Brocade.com>
To: "christian.ehrhardt@canonical.com" <christian.ehrhardt@canonical.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v2 0/4] provide man pages for binaries provided by DPDK
Date: Wed, 14 Sep 2016 11:58:57 +0000 [thread overview]
Message-ID: <1473854336.8480.10.camel@brocade.com> (raw)
In-Reply-To: <1472629812-4397-1-git-send-email-christian.ehrhardt@canonical.com>
On Wed, 2016-08-31 at 09:50 +0200, Christian Ehrhardt wrote:
> *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
Acked-by: Luca Boccassi <lboccass@brocade.com>
--
Kind regards,
Luca Boccassi
next prev parent reply other threads:[~2016-09-14 11:59 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-04 11:16 [dpdk-dev] [PATCH " Christian Ehrhardt
2016-08-04 11:16 ` [dpdk-dev] [PATCH 1/4] doc: rendering and installation of man pages Christian Ehrhardt
2016-08-30 14:52 ` Mcnamara, John
2016-08-04 11:16 ` [dpdk-dev] [PATCH 2/4] doc: add basic invocation info for dpdk-pmdinfo Christian Ehrhardt
2016-08-30 14:59 ` Mcnamara, John
2016-08-31 7:29 ` Christian Ehrhardt
2016-08-04 11:16 ` [dpdk-dev] [PATCH 3/4] doc: add basic invocation info for dpdk-devbind Christian Ehrhardt
2016-08-30 15:05 ` Mcnamara, John
2016-08-31 7:47 ` Christian Ehrhardt
2016-08-04 11:16 ` [dpdk-dev] [PATCH 4/4] doc: make the devbind man page be part of section 8 Christian Ehrhardt
2016-08-30 15:12 ` Mcnamara, John
2016-08-31 6:45 ` Christian Ehrhardt
2016-08-30 14:51 ` [dpdk-dev] [PATCH 0/4] provide man pages for binaries provided by DPDK Mcnamara, John
2016-08-31 5:54 ` Panu Matilainen
2016-08-31 6:46 ` Christian Ehrhardt
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 " Christian Ehrhardt
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 1/4] doc: move tool guides in their own subdirectory Christian Ehrhardt
2016-09-26 15:13 ` Mcnamara, John
2016-09-26 16:16 ` Christian Ehrhardt
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 2/4] doc: rendering and installation of man pages Christian Ehrhardt
2016-09-26 15:14 ` Mcnamara, John
2016-10-26 21:13 ` Thomas Monjalon
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 3/4] doc: add basic invocation info for dpdk-pmdinfo Christian Ehrhardt
2016-09-26 15:14 ` Mcnamara, John
2016-08-31 7:50 ` [dpdk-dev] [PATCH v2 4/4] doc: add basic invocation info for dpdk-devbind Christian Ehrhardt
2016-09-26 15:15 ` Mcnamara, John
2016-09-14 11:58 ` Luca Boccassi [this message]
2016-10-26 21:32 ` [dpdk-dev] [PATCH v2 0/4] provide man pages for binaries provided by DPDK Thomas Monjalon
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=1473854336.8480.10.camel@brocade.com \
--to=lboccass@brocade.com \
--cc=christian.ehrhardt@canonical.com \
--cc=dev@dpdk.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).