[Pkg-ofed-commits] [infiniband-diags] 13/18: Fix man page warnings/errors

Benjamin Drung bdrung at moszumanska.debian.org
Mon Aug 21 16:13:39 UTC 2017 

This is an automated email from the git hooks/post-receive script.

bdrung pushed a commit to branch master
in repository infiniband-diags.

commit aa57e46bf0e0c9c91af630cb6ce7d17a36b7a5d5
Author: Benjamin Drung <benjamin.drung at profitbricks.com>
Date:   Mon Aug 21 16:53:17 2017 +0200

    Fix man page warnings/errors
---
 .../0001-Fix-bad-whatis-entries-in-man-pages.patch | 424 +++++++++++++++++++++
 ...2-Fix-undefined-bi-macro-man-page-warning.patch |  32 ++
 debian/patches/series                              |   2 +
 3 files changed, 458 insertions(+)

diff --git a/debian/patches/0001-Fix-bad-whatis-entries-in-man-pages.patch b/debian/patches/0001-Fix-bad-whatis-entries-in-man-pages.patch
new file mode 100644
index 0000000..0162349
--- /dev/null
+++ b/debian/patches/0001-Fix-bad-whatis-entries-in-man-pages.patch
@@ -0,0 +1,424 @@
+From 0edbdd74cd89d90c80ecd94c0e91279020e1dbbf Mon Sep 17 00:00:00 2001
+From: Benjamin Drung <benjamin.drung at profitbricks.com>
+Date: Mon, 21 Aug 2017 16:40:41 +0200
+Subject: [PATCH 1/2] Fix bad whatis entries in man pages
+
+Each manual page should start with a "NAME" section, which lists the
+name and a brief description of the page separated by "\-". The "NAME"
+section is parsed by lexgrog and used to generate a database that's
+queried by commands like apropos and whatis.
+
+Regenerating the man pages with rst2man will cause the man pages to have
+malformed whatis entries if the metadata comes before the brief
+description in the reStructured text.
+
+Signed-off-by: Benjamin Drung <benjamin.drung at profitbricks.com>
+---
+ doc/rst/check_lft_balance.8.in.rst |  9 ++++-----
+ doc/rst/ibcacheedit.8.in.rst       |  9 ++++-----
+ doc/rst/ibfindnodesusing.8.in.rst  |  9 ++++-----
+ doc/rst/ibidsverify.8.in.rst       | 10 +++++-----
+ doc/rst/ibroute.8.in.rst           |  9 ++++-----
+ doc/rst/ibstat.8.in.rst            |  9 ++++-----
+ doc/rst/ibstatus.8.in.rst          |  9 ++++-----
+ doc/rst/ibsysstat.8.in.rst         |  9 ++++-----
+ doc/rst/ibtracert.8.in.rst         | 10 +++++-----
+ doc/rst/infiniband-diags.8.in.rst  |  9 ++++-----
+ doc/rst/perfquery.8.in.rst         |  9 ++++-----
+ doc/rst/saquery.8.in.rst           |  9 ++++-----
+ doc/rst/sminfo.8.in.rst            | 10 +++++-----
+ doc/rst/smpdump.8.in.rst           |  9 ++++-----
+ doc/rst/smpquery.8.in.rst          |  9 ++++-----
+ doc/rst/vendstat.8.in.rst          |  9 ++++-----
+ 16 files changed, 67 insertions(+), 80 deletions(-)
+
+diff --git a/doc/rst/check_lft_balance.8.in.rst b/doc/rst/check_lft_balance.8.in.rst
+index 96c41f2..2639a20 100644
+--- a/doc/rst/check_lft_balance.8.in.rst
++++ b/doc/rst/check_lft_balance.8.in.rst
+@@ -1,15 +1,14 @@
+ =================
+-CHECK_LFT_BALANCE
++check_lft_balance
+ =================
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ --------------------------------------------------
+ check InfiniBand unicast forwarding tables balance
+ --------------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/ibcacheedit.8.in.rst b/doc/rst/ibcacheedit.8.in.rst
+index 5d61efb..69028cd 100644
+--- a/doc/rst/ibcacheedit.8.in.rst
++++ b/doc/rst/ibcacheedit.8.in.rst
+@@ -1,15 +1,14 @@
+ ===========
+-IBCACHEEDIT
++ibcacheedit
+ ===========
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ---------------------------
+ edit an ibnetdiscover cache
+ ---------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/ibfindnodesusing.8.in.rst b/doc/rst/ibfindnodesusing.8.in.rst
+index 573dea9..e3ba0ae 100644
+--- a/doc/rst/ibfindnodesusing.8.in.rst
++++ b/doc/rst/ibfindnodesusing.8.in.rst
+@@ -1,15 +1,14 @@
+ ================
+-IBFINDNODESUSING
++ibfindnodesusing
+ ================
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ -------------------------------------------------------------------------------
+ find a list of end nodes which are routed through the specified switch and port
+ -------------------------------------------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/ibidsverify.8.in.rst b/doc/rst/ibidsverify.8.in.rst
+index 3614333..ece8ea0 100644
+--- a/doc/rst/ibidsverify.8.in.rst
++++ b/doc/rst/ibidsverify.8.in.rst
+@@ -1,15 +1,15 @@
+ ===========
+-IBIDSVERIFY
++ibidsverify
+ ===========
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ---------------------------------------------------
+ validate IB identifiers in subnet and report errors
+ ---------------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
++
+ SYNOPSIS
+ ========
+ 
+diff --git a/doc/rst/ibroute.8.in.rst b/doc/rst/ibroute.8.in.rst
+index 5870de6..4163b80 100644
+--- a/doc/rst/ibroute.8.in.rst
++++ b/doc/rst/ibroute.8.in.rst
+@@ -1,15 +1,14 @@
+ =======
+-IBROUTE
++ibroute
+ =======
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ -----------------------------------------
+ query InfiniBand switch forwarding tables
+ -----------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/ibstat.8.in.rst b/doc/rst/ibstat.8.in.rst
+index 3e19b3e..baf2d3d 100644
+--- a/doc/rst/ibstat.8.in.rst
++++ b/doc/rst/ibstat.8.in.rst
+@@ -1,15 +1,14 @@
+ ======
+-IBSTAT
++ibstat
+ ======
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ------------------------------------------
+ query basic status of InfiniBand device(s)
+ ------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/ibstatus.8.in.rst b/doc/rst/ibstatus.8.in.rst
+index cfdac68..e2e5b2d 100644
+--- a/doc/rst/ibstatus.8.in.rst
++++ b/doc/rst/ibstatus.8.in.rst
+@@ -1,15 +1,14 @@
+ ========
+-IBSTATUS
++ibstatus
+ ========
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ------------------------------------------
+ query basic status of InfiniBand device(s)
+ ------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/ibsysstat.8.in.rst b/doc/rst/ibsysstat.8.in.rst
+index 3a7b295..df0764f 100644
+--- a/doc/rst/ibsysstat.8.in.rst
++++ b/doc/rst/ibsysstat.8.in.rst
+@@ -1,15 +1,14 @@
+ =========
+-IBSYSSTAT
++ibsysstat
+ =========
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ --------------------------------------
+ system status on an InfiniBand address
+ --------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/ibtracert.8.in.rst b/doc/rst/ibtracert.8.in.rst
+index 76fe568..021e690 100644
+--- a/doc/rst/ibtracert.8.in.rst
++++ b/doc/rst/ibtracert.8.in.rst
+@@ -1,15 +1,15 @@
+ =========
+-IBTRACERT
++ibtracert
+ =========
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ---------------------
+ trace InfiniBand path
+ ---------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
++
+ SYNOPSIS
+ ========
+ 
+diff --git a/doc/rst/infiniband-diags.8.in.rst b/doc/rst/infiniband-diags.8.in.rst
+index be77ce3..571d4cc 100644
+--- a/doc/rst/infiniband-diags.8.in.rst
++++ b/doc/rst/infiniband-diags.8.in.rst
+@@ -1,15 +1,14 @@
+ ================
+-INFINIBAND-DIAGS
++infiniband-diags
+ ================
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ----------------------------------
+ Diagnostics for InfiniBand Fabrics
+ ----------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ DESCRIPTION
+ ===========
+diff --git a/doc/rst/perfquery.8.in.rst b/doc/rst/perfquery.8.in.rst
+index 5e3d709..c09c3e1 100644
+--- a/doc/rst/perfquery.8.in.rst
++++ b/doc/rst/perfquery.8.in.rst
+@@ -1,15 +1,14 @@
+ =========
+-PERFQUERY
++perfquery
+ =========
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ -----------------------------------------------
+ query InfiniBand port counters on a single port
+ -----------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/saquery.8.in.rst b/doc/rst/saquery.8.in.rst
+index 0551917..9647297 100644
+--- a/doc/rst/saquery.8.in.rst
++++ b/doc/rst/saquery.8.in.rst
+@@ -1,15 +1,14 @@
+ =======
+-SAQUERY
++saquery
+ =======
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ -------------------------------------------------
+ query InfiniBand subnet administration attributes
+ -------------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/sminfo.8.in.rst b/doc/rst/sminfo.8.in.rst
+index 500d1d0..4d715d7 100644
+--- a/doc/rst/sminfo.8.in.rst
++++ b/doc/rst/sminfo.8.in.rst
+@@ -1,15 +1,15 @@
+ ======
+-SMINFO
++sminfo
+ ======
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ---------------------------------
+ query InfiniBand SMInfo attribute
+ ---------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
++
+ SYNOPSIS
+ ========
+ 
+diff --git a/doc/rst/smpdump.8.in.rst b/doc/rst/smpdump.8.in.rst
+index 38460de..118288f 100644
+--- a/doc/rst/smpdump.8.in.rst
++++ b/doc/rst/smpdump.8.in.rst
+@@ -1,15 +1,14 @@
+ =======
+-SMPDUMP
++smpdump
+ =======
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ --------------------------------------------
+ dump InfiniBand subnet management attributes
+ --------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/smpquery.8.in.rst b/doc/rst/smpquery.8.in.rst
+index aa9983c..8ca98ab 100644
+--- a/doc/rst/smpquery.8.in.rst
++++ b/doc/rst/smpquery.8.in.rst
+@@ -1,15 +1,14 @@
+ ========
+-SMPQUERY
++smpquery
+ ========
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ---------------------------------------------
+ query InfiniBand subnet management attributes
+ ---------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+diff --git a/doc/rst/vendstat.8.in.rst b/doc/rst/vendstat.8.in.rst
+index abb4e33..7b5e9e6 100644
+--- a/doc/rst/vendstat.8.in.rst
++++ b/doc/rst/vendstat.8.in.rst
+@@ -1,15 +1,14 @@
+ ========
+-VENDSTAT
++vendstat
+ ========
+ 
+-:Date: @BUILD_DATE@
+-:Manual section: 8
+-:Manual group: Open IB Diagnostics
+-
+ ------------------------------------------
+ query InfiniBand vendor specific functions
+ ------------------------------------------
+ 
++:Date: @BUILD_DATE@
++:Manual section: 8
++:Manual group: Open IB Diagnostics
+ 
+ SYNOPSIS
+ ========
+-- 
+2.11.0
+
diff --git a/debian/patches/0002-Fix-undefined-bi-macro-man-page-warning.patch b/debian/patches/0002-Fix-undefined-bi-macro-man-page-warning.patch
new file mode 100644
index 0000000..0b500ad
--- /dev/null
+++ b/debian/patches/0002-Fix-undefined-bi-macro-man-page-warning.patch
@@ -0,0 +1,32 @@
+From 91630fc4e2989cea9a589e1ed0430d30fa7b72b1 Mon Sep 17 00:00:00 2001
+From: Benjamin Drung <benjamin.drung at profitbricks.com>
+Date: Mon, 21 Aug 2017 16:46:12 +0200
+Subject: [PATCH 2/2] Fix undefined bi macro man page warning
+
+THe ibnd_discover_fabric.3 man page provokes warning from man:
+
+$ LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l \
+    -Tutf8 -Z libibnetdisc/man/ibnd_discover_fabric.3 >/dev/null
+<standard input>:8: warning: macro `bi' not defined
+
+Signed-off-by: Benjamin Drung <benjamin.drung at profitbricks.com>
+---
+ libibnetdisc/man/ibnd_discover_fabric.3 | 2 +-
+ 1 file changed, 1 insertion(+), 1 deletion(-)
+
+diff --git a/libibnetdisc/man/ibnd_discover_fabric.3 b/libibnetdisc/man/ibnd_discover_fabric.3
+index 5471af0..2c09da7 100644
+--- a/libibnetdisc/man/ibnd_discover_fabric.3
++++ b/libibnetdisc/man/ibnd_discover_fabric.3
+@@ -5,7 +5,7 @@ ibnd_discover_fabric, ibnd_destroy_fabric, ibnd_debug ibnd_show_progress \- init
+ .nf
+ .B #include <infiniband/ibnetdisc.h>
+ .sp
+-.bi "ibnd_fabric_t *ibnd_discover_fabric(struct ibmad_port *ibmad_port, int timeout_ms, ib_portid_t *from, int hops)"
++.BI "ibnd_fabric_t *ibnd_discover_fabric(struct ibmad_port *ibmad_port, int timeout_ms, ib_portid_t *from, int hops)"
+ .BI "void ibnd_destroy_fabric(ibnd_fabric_t *fabric)"
+ .BI "void ibnd_debug(int i)"
+ .BI "void ibnd_show_progress(int i)"
+-- 
+2.11.0
+
diff --git a/debian/patches/series b/debian/patches/series
index e613ac0..cf53933 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,3 @@
 comment_test_out
+0001-Fix-bad-whatis-entries-in-man-pages.patch
+0002-Fix-undefined-bi-macro-man-page-warning.patch

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-ofed/infiniband-diags.git

More information about the Pkg-ofed-commits mailing list