From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from youngberry.canonical.com (youngberry.canonical.com [91.189.89.112]) by dpdk.org (Postfix) with ESMTP id A58182C29 for ; Thu, 4 Aug 2016 13:17:02 +0200 (CEST) Received: from 1.general.paelzer.uk.vpn ([10.172.196.172] helo=localhost.localdomain) by youngberry.canonical.com with esmtpsa (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.76) (envelope-from ) id 1bVGe6-0008Fa-6z; Thu, 04 Aug 2016 11:17:02 +0000 From: Christian Ehrhardt To: christian.ehrhardt@canonical.com, thomas.monjalon@6wind.com, dev@dpdk.org Date: Thu, 4 Aug 2016 13:16:55 +0200 Message-Id: <1470309419-4389-1-git-send-email-christian.ehrhardt@canonical.com> X-Mailer: git-send-email 2.7.4 Subject: [dpdk-dev] [PATCH 0/4] provide man pages for binaries provided by DPDK X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 04 Aug 2016 11:17:02 -0000 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: rendering and installation of man pages doc: add basic invocation info for dpdk-pmdinfo doc: add basic invocation info for dpdk-devbind doc: make the devbind man page be part of section 8 doc/guides/conf.py | 12 +++ doc/guides/sample_app_ug/devbind.rst | 150 +++++++++++++++++++++++++++++++++++ doc/guides/sample_app_ug/index.rst | 2 + doc/guides/sample_app_ug/pmdinfo.rst | 62 +++++++++++++++ mk/rte.sdkdoc.mk | 2 +- mk/rte.sdkinstall.mk | 11 +++ 6 files changed, 238 insertions(+), 1 deletion(-) create mode 100644 doc/guides/sample_app_ug/devbind.rst create mode 100644 doc/guides/sample_app_ug/pmdinfo.rst -- 2.7.4