search

linux-rdma / opensm

Other
66 stars 36 forks source link

opensm has errors from man #10

Closed bdrung closed 5 years ago

bdrung commented 5 years ago

The opensm man page provokes warnings or errors from man:

(unstable)root@host:~# LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z /usr/share/man/man8/opensm.8.gz >/dev/null
<standard input>:584: warning [p 9, 1.0i]: cannot adjust line
<standard input>:748: warning [p 11, 6.0i]: cannot adjust line
<standard input>:749: warning [p 11, 6.3i]: cannot adjust line

"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).

Lintian also stricter in regards to declaring manpage preprocessors.

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
hnrose commented 5 years ago

Implemented patch to quiet those warnings and sent to you for review/testing.

bdrung commented 5 years ago

The patch silences lintian. :+1:

hnrose commented 5 years ago

Patch was just pushed