[dpdk-dev,4/4] doc: make the devbind man page be part of section 8

Message ID 1470309419-4389-5-git-send-email-christian.ehrhardt@canonical.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Commit Message

Christian Ehrhardt Aug. 4, 2016, 11:16 a.m. UTC
  As a root only program in sbin it should belong to section 8
"8   System administration commands (usually only for root)"

Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
---
 doc/guides/conf.py   | 2 +-
 mk/rte.sdkinstall.mk | 5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)
  

Comments

John McNamara Aug. 30, 2016, 3:12 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Christian Ehrhardt
> Sent: Thursday, August 4, 2016 12:17 PM
> To: christian.ehrhardt@canonical.com; thomas.monjalon@6wind.com;
> dev@dpdk.org
> Subject: [dpdk-dev] [PATCH 4/4] doc: make the devbind man page be part of
> section 8
> 
> As a root only program in sbin it should belong to section 8
> "8   System administration commands (usually only for root)"
> 
> Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
> ---
>  doc/guides/conf.py   | 2 +-
>  mk/rte.sdkinstall.mk | 5 +++++
>  2 files changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/conf.py b/doc/guides/conf.py index
> ad8e8b3..52e2acf 100644
> --- a/doc/guides/conf.py
> +++ b/doc/guides/conf.py
> @@ -102,7 +102,7 @@ man_pages = [("testpmd_app_ug/run_app", "testpmd",
>               ("sample_app_ug/pmdinfo", "dpdk-pmdinfo",
>                "dump a PMDs hardware support info", "", 1),
>               ("sample_app_ug/devbind", "dpdk-devbind",
> -              "check device status and bind/unbind them from drivers",
> "", 1)]
> +              "check device status and bind/unbind them from drivers",
> + "", 8)]


Could this be rolled into one of the earlier patches?
  
Christian Ehrhardt Aug. 31, 2016, 6:45 a.m. UTC | #2
Damn, I'm payed by # of commits :-P
That can of course  be squashed with the actual devbind patch.
I already thought about it before and hearing another voice asking for it
is enough to convince me.

On Tue, Aug 30, 2016 at 5:12 PM, Mcnamara, John <john.mcnamara@intel.com>
wrote:

>
>
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Christian Ehrhardt
> > Sent: Thursday, August 4, 2016 12:17 PM
> > To: christian.ehrhardt@canonical.com; thomas.monjalon@6wind.com;
> > dev@dpdk.org
> > Subject: [dpdk-dev] [PATCH 4/4] doc: make the devbind man page be part of
> > section 8
> >
> > As a root only program in sbin it should belong to section 8
> > "8   System administration commands (usually only for root)"
> >
> > Signed-off-by: Christian Ehrhardt <christian.ehrhardt@canonical.com>
> > ---
> >  doc/guides/conf.py   | 2 +-
> >  mk/rte.sdkinstall.mk | 5 +++++
> >  2 files changed, 6 insertions(+), 1 deletion(-)
> >
> > diff --git a/doc/guides/conf.py b/doc/guides/conf.py index
> > ad8e8b3..52e2acf 100644
> > --- a/doc/guides/conf.py
> > +++ b/doc/guides/conf.py
> > @@ -102,7 +102,7 @@ man_pages = [("testpmd_app_ug/run_app", "testpmd",
> >               ("sample_app_ug/pmdinfo", "dpdk-pmdinfo",
> >                "dump a PMDs hardware support info", "", 1),
> >               ("sample_app_ug/devbind", "dpdk-devbind",
> > -              "check device status and bind/unbind them from drivers",
> > "", 1)]
> > +              "check device status and bind/unbind them from drivers",
> > + "", 8)]
>
>
> Could this be rolled into one of the earlier patches?
>
>
>
  

Patch

diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index ad8e8b3..52e2acf 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -102,7 +102,7 @@  man_pages = [("testpmd_app_ug/run_app", "testpmd",
              ("sample_app_ug/pmdinfo", "dpdk-pmdinfo",
               "dump a PMDs hardware support info", "", 1),
              ("sample_app_ug/devbind", "dpdk-devbind",
-              "check device status and bind/unbind them from drivers", "", 1)]
+              "check device status and bind/unbind them from drivers", "", 8)]
 
 ######## :numref: fallback ########
 # The following hook functions add some simple handling for the :numref:
diff --git a/mk/rte.sdkinstall.mk b/mk/rte.sdkinstall.mk
index 533d369..b1faf28 100644
--- a/mk/rte.sdkinstall.mk
+++ b/mk/rte.sdkinstall.mk
@@ -139,6 +139,11 @@  ifneq ($(wildcard $O/doc/man/*/*.1),)
 	$(Q)$(call rte_mkdir,     $(DESTDIR)$(mandir)/man1)
 	$(Q)cp -a $O/doc/man/*/*.1 $(DESTDIR)$(mandir)/man1
 endif
+ifneq ($(wildcard $O/doc/man/*/*.8),)
+	$(Q)$(call rte_mkdir,     $(DESTDIR)$(mandir))
+	$(Q)$(call rte_mkdir,     $(DESTDIR)$(mandir)/man8)
+	$(Q)cp -a $O/doc/man/*/*.8 $(DESTDIR)$(mandir)/man8
+endif
 
 install-kmod:
 ifneq ($(wildcard $O/kmod/*),)