[Pkg-ofed-commits] [libfabric] 08/18: Fix manpages have bad whatis entries

Wed Nov 29 16:04:06 UTC 2017

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

bdrung pushed a commit to branch master
in repository libfabric.

commit eda2d31a986b5fbcc1681ec08b5d48955b91f04e
Author: Benjamin Drung <bdrung at debian.org>
Date:   Wed Nov 29 15:15:00 2017 +0100

    Fix manpages have bad whatis entries
    
    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. This tag indicates that
    lexgrog was unable to parse the NAME section of this manual page.
    
    For manual pages that document multiple programs, functions, files, or
    other things, the part before "\-" should list each separated by a
    comma and a space. Each thing listed must not contain spaces; a man
    page for a two-part command like "fs listacl" must use something like
    "fs_listacl" in the "NAME" section so that it can be parsed by
    lexgrog.
    
    Refer to the lexgrog(1) manual page, the groff_man(7) manual page, and
    the groff_mdoc(7) manual page for details.
---
 .../patches/fix-manpage-has-bad-whatis-entry.patch | 164 +++++++++++++++++++++
 debian/patches/series                              |   1 +
 2 files changed, 165 insertions(+)

diff --git a/debian/patches/fix-manpage-has-bad-whatis-entry.patch b/debian/patches/fix-manpage-has-bad-whatis-entry.patch
new file mode 100644
index 0000000..45150bf
--- /dev/null
+++ b/debian/patches/fix-manpage-has-bad-whatis-entry.patch
@@ -0,0 +1,164 @@
+Description: Fix manpages have bad whatis entries
+ 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. This tag indicates that
+ lexgrog was unable to parse the NAME section of this manual page.
+ .
+ For manual pages that document multiple programs, functions, files, or
+ other things, the part before "\-" should list each separated by a
+ comma and a space. Each thing listed must not contain spaces; a man
+ page for a two-part command like "fs listacl" must use something like
+ "fs_listacl" in the "NAME" section so that it can be parsed by
+ lexgrog.
+ .
+ Refer to the lexgrog(1) manual page, the groff_man(7) manual page, and
+ the groff_mdoc(7) manual page for details.
+Author: Benjamin Drung <bdrung at debian.org>
+
+--- libfabric-1.5.2.orig/man/man3/fi_getinfo.3
++++ libfabric-1.5.2/man/man3/fi_getinfo.3
+@@ -1,9 +1,9 @@
+ .TH "fi_getinfo" "3" "2017\-07\-25" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-fi_getinfo / fi_freeinfo \- Obtain / free fabric interface information
++fi_getinfo, fi_freeinfo \- Obtain / free fabric interface information
+ .PP
+-fi_allocinfo / fi_dupinfo \- Allocate / duplicate an fi_info structure
++fi_allocinfo, fi_dupinfo \- Allocate / duplicate an fi_info structure
+ .SH SYNOPSIS
+ .IP
+ .nf
+--- libfabric-1.5.2.orig/man/man7/fabric.7
++++ libfabric-1.5.2/man/man7/fabric.7
+@@ -1,7 +1,7 @@
+ .TH "fabric" "7" "2016\-06\-29" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-Fabric Interface Library
++fabric \- Fabric Interface Library
+ .SH SYNOPSIS
+ .IP
+ .nf
+--- libfabric-1.5.2.orig/man/man7/fi_bgq.7
++++ libfabric-1.5.2/man/man7/fi_bgq.7
+@@ -1,7 +1,7 @@
+ .TH "fi_bgq" "7" "2017\-02\-27" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The Blue Gene/Q Fabric Provider
++fi_bgq \- The Blue Gene/Q Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The bgq provider is a native implementation of the libfabric interfaces
+--- libfabric-1.5.2.orig/man/man7/fi_direct.7
++++ libfabric-1.5.2/man/man7/fi_direct.7
+@@ -1,7 +1,7 @@
+ .TH "fi_direct" "7" "2017\-04\-13" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-Direct fabric provider access
++fi_direct \- Direct fabric provider access
+ .SH SYNOPSIS
+ .IP
+ .nf
+--- libfabric-1.5.2.orig/man/man7/fi_gni.7
++++ libfabric-1.5.2/man/man7/fi_gni.7
+@@ -1,7 +1,7 @@
+ .TH "fi_gni" "7" "2017\-07\-21" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The GNI Fabric Provider
++fi_gni \- The GNI Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The GNI provider runs on Cray XC (TM) systems utilizing the user\-space
+--- libfabric-1.5.2.orig/man/man7/fi_mlx.7
++++ libfabric-1.5.2/man/man7/fi_mlx.7
+@@ -1,7 +1,7 @@
+ .TH "fi_mlx" "7" "2017\-04\-18" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The MLX Fabric Provider
++fi_mlx \- The MLX Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The \f[I]mlx\f[] provider runs over the UCX library that is currently
+--- libfabric-1.5.2.orig/man/man7/fi_provider.7
++++ libfabric-1.5.2/man/man7/fi_provider.7
+@@ -1,7 +1,7 @@
+ .TH "fi_provider" "7" "2017\-07\-24" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-Fabric Interface Providers
++fi_provider \- Fabric Interface Providers
+ .SH OVERVIEW
+ .PP
+ Conceptually, a fabric provider may be viewed as a local hardware NIC
+--- libfabric-1.5.2.orig/man/man7/fi_psm.7
++++ libfabric-1.5.2/man/man7/fi_psm.7
+@@ -1,7 +1,7 @@
+ .TH "fi_psm" "7" "2016\-02\-28" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The PSM Fabric Provider
++fi_psm \- The PSM Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The \f[I]psm\f[] provider runs over the PSM 1.x interface that is
+--- libfabric-1.5.2.orig/man/man7/fi_psm2.7
++++ libfabric-1.5.2/man/man7/fi_psm2.7
+@@ -1,7 +1,7 @@
+ .TH "fi_psm2" "7" "2017\-07\-05" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The PSM2 Fabric Provider
++fi_psm2 \- The PSM2 Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The \f[I]psm2\f[] provider runs over the PSM 2.x interface that is
+--- libfabric-1.5.2.orig/man/man7/fi_sockets.7
++++ libfabric-1.5.2/man/man7/fi_sockets.7
+@@ -1,7 +1,7 @@
+ .TH "fi_sockets" "7" "2017\-08\-09" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The Sockets Fabric Provider
++fi_sockets \- The Sockets Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The sockets provider is a general purpose provider that can be used on
+--- libfabric-1.5.2.orig/man/man7/fi_udp.7
++++ libfabric-1.5.2/man/man7/fi_udp.7
+@@ -1,7 +1,7 @@
+ .TH "fi_udp" "7" "2017\-07\-27" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The UDP Fabric Provider
++fi_udp \- The UDP Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The UDP provider is a basic provider that can be used on any system that
+--- libfabric-1.5.2.orig/man/man7/fi_usnic.7
++++ libfabric-1.5.2/man/man7/fi_usnic.7
+@@ -1,7 +1,7 @@
+ .TH "fi_usnic" "7" "2017\-07\-24" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The usNIC Fabric Provider
++fi_usnic \- The usNIC Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The \f[I]usnic\f[] provider is designed to run over the Cisco VIC
+--- libfabric-1.5.2.orig/man/man7/fi_verbs.7
++++ libfabric-1.5.2/man/man7/fi_verbs.7
+@@ -1,7 +1,7 @@
+ .TH "fi_verbs" "7" "2017\-07\-24" "Libfabric Programmer\[aq]s Manual" "Libfabric v1.5.2"
+ .SH NAME
+ .PP
+-The Verbs Fabric Provider
++fi_verbs \- The Verbs Fabric Provider
+ .SH OVERVIEW
+ .PP
+ The verbs provider enables applications using OFI to be run over any
diff --git a/debian/patches/series b/debian/patches/series
index 770c395..8cd595d 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1 +1,2 @@
 fix-spelling-errors.patch
+fix-manpage-has-bad-whatis-entry.patch

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

