[Pkg-ofed-commits] [libfabric] 09/18: Add patch to fix manpage errors from man

Benjamin Drung bdrung at moszumanska.debian.org
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 2b0d21c1abc78515fe0199a7f72ed0601e703f48
Author: Benjamin Drung <bdrung at debian.org>
Date:   Wed Nov 29 15:43:45 2017 +0100

    Add patch to fix manpage errors from man
    
    Some man page provokes warnings or errors from man.
    
    "cannot adjust" or "can't break" are trouble with paragraph filling,
    usually related to long lines. Adjustment can be helped by left
    justifying, breaks can be helped with hyphenation, see "Manipulating
    Filling and Adjusting" and "Manipulating Hyphenation" in the groff
    manual (see info groff).
    
    To test this for yourself you can use the following command:
     LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
          man --warnings -E UTF-8 -l -Tutf8 -Z <file> >/dev/null
    
    Refer to the groff_man(7) manual page and the groff_mdoc(7) manual
    page for details.
---
 debian/patches/fix-manpage-errors-from-man.patch | 77 ++++++++++++++++++++++++
 debian/patches/series                            |  1 +
 2 files changed, 78 insertions(+)

diff --git a/debian/patches/fix-manpage-errors-from-man.patch b/debian/patches/fix-manpage-errors-from-man.patch
new file mode 100644
index 0000000..b76ee63
--- /dev/null
+++ b/debian/patches/fix-manpage-errors-from-man.patch
@@ -0,0 +1,77 @@
+Description: Wrap long lines in man pages
+ Some man page provokes warnings or errors from man.
+ .
+ "cannot adjust" or "can't break" are trouble with paragraph filling,
+ usually related to long lines. Adjustment can be helped by left
+ justifying, breaks can be helped with hyphenation, see "Manipulating
+ Filling and Adjusting" and "Manipulating Hyphenation" in the groff
+ manual (see info groff).
+ .
+ To test this for yourself you can use the following command:
+  LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
+          man --warnings -E UTF-8 -l -Tutf8 -Z <file> >/dev/null
+ .
+ Refer to the groff_man(7) manual page and the groff_mdoc(7) manual
+ page for details.
+Author: Benjamin Drung <bdrung at debian.org>
+
+--- a/man/man3/fi_getinfo.3
++++ b/man/man3/fi_getinfo.3
+@@ -11,7 +11,8 @@
+ #include\ <rdma/fabric.h>
+ 
+ int\ fi_getinfo(int\ version,\ const\ char\ *node,\ const\ char\ *service,
+-\ \ \ \ \ \ \ \ uint64_t\ flags,\ struct\ fi_info\ *hints,\ struct\ fi_info\ **info);
++\ \ \ \ \ \ \ \ uint64_t\ flags,\ struct\ fi_info\ *hints,
++\ \ \ \ \ \ \ \ struct\ fi_info\ **info);
+ 
+ void\ fi_freeinfo(struct\ fi_info\ *info);
+ 
+@@ -607,7 +608,9 @@
+ The length and content of the string is address and/or provider
+ specific, but in general follows a URI model:
+ .PP
++.nf
+ address_format[://[node][:[service][/[field3]...][?[key=value][&k2=v2]...]]]
++.fi
+ .PP
+ Examples: \- fi_sockaddr://10.31.6.12:7471 \-
+ fi_sockaddr_in6://[fe80::6:12]:7471 \-
+--- a/man/man3/fi_trigger.3
++++ b/man/man3/fi_trigger.3
+@@ -48,7 +48,7 @@
+ .nf
+ \f[C]
+ struct\ fi_triggered_context\ {
+-\ \ \ \ enum\ fi_trigger_event\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ event_type;\ \ \ /*\ trigger\ type\ */
++\ \ \ \ enum\ fi_trigger_event\ \ \ \ \ \ \ \ \ event_type;\ \ \ /*\ trigger\ type\ */
+ \ \ \ \ union\ {
+ \ \ \ \ \ \ \ \ struct\ fi_trigger_threshold\ threshold;
+ \ \ \ \ \ \ \ \ void\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ *internal[3];\ /*\ reserved\ */
+@@ -56,7 +56,7 @@
+ };
+ 
+ struct\ fi_triggered_context2\ {
+-\ \ \ \ enum\ fi_trigger_event\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ event_type;\ \ \ /*\ trigger\ type\ */
++\ \ \ \ enum\ fi_trigger_event\ \ \ \ \ \ \ \ \ event_type;\ \ \ /*\ trigger\ type\ */
+ \ \ \ \ union\ {
+ \ \ \ \ \ \ \ \ struct\ fi_trigger_threshold\ threshold;
+ \ \ \ \ \ \ \ \ void\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ *internal[7];\ /*\ reserved\ */
+@@ -76,8 +76,15 @@
+ operation will be deferred until an event counter crosses an application
+ specified threshold value.
+ The threshold is specified using struct fi_trigger_threshold:
+-.PP
+-\f[C]c\ \ \ struct\ fi_trigger_threshold\ {\ \ \ \ \ struct\ fid_cntr\ *cntr;\ /*\ event\ counter\ to\ check\ */\ \ \ \ \ size_t\ threshold;\ \ \ \ \ \ /*\ threshold\ value\ */\ \ \ };\f[]
++.IP
++.nf
++\f[C]
++struct\ fi_trigger_threshold\ {
++\ \ \ \ \ struct\ fid_cntr\ *cntr;\ \ \ \ \ /*\ event\ counter\ to\ check\ */
++\ \ \ \ \ size_t\ threshold;\ \ \ \ \ \ \ \ \ \ /*\ threshold\ value\ */
++};
++\f[]
++.fi
+ .PP
+ Threshold operations are triggered in the order of the threshold values.
+ This is true even if the counter increments by a value greater than 1.
diff --git a/debian/patches/series b/debian/patches/series
index 8cd595d..3d023fb 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,2 +1,3 @@
 fix-spelling-errors.patch
 fix-manpage-has-bad-whatis-entry.patch
+fix-manpage-errors-from-man.patch

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



More information about the Pkg-ofed-commits mailing list