Hi,
The swift package has a lot of Lintian warnings about man pages, it would be nice if these were fixed (especially the non manpage missing ones).
I: swift: hyphen-used-as-minus-sign usr/share/man/man1/swift-orphans.1.gz:28
N:
N: This manual page seems to contain a hyphen where a minus sign was
N: intended. By default, "-" chars are interpreted as hyphens (U+2010) by
N: groff, not as minus signs (U+002D). Since options to programs use minus
N: signs (U+002D), this means for example in UTF-8 locales that you cannot
N: cut and paste options, nor search for them easily. The Debian groff
N: package currently forces "-" to be interpreted as a minus sign due to
N: the number of manual pages with this problem, but this is a
N: Debian-specific modification and hopefully eventually can be removed.
N:
N: "-" must be escaped ("\-") to be interpreted as minus. If you really
N: intend a hyphen (normally you don't), write it as "\(hy" to emphasise
N: that fact. See groff(7) and especially groff_char(7) for details, and
N: also the thread starting with
N: http://lists.debian.org/debian-devel/2003/debian-devel-200303/msg01481.h
N: tml
N:
N: If you use some tool that converts your documentation to groff format,
N: this tag may indicate a bug in the tool. Some tools convert dashes of
N: any kind to hyphens. The safe way of converting dashes is to convert
N: them to "\-".
N:
N: Because this error can occur very often, Lintian shows only the first 10
N: occurrences for each man page and give the number of suppressed
N: occurrences. If you want to see all warnings, run Lintian with the
N: -d/--debug option.
N:
N: Refer to /usr/share/doc/groff-base/README.Debian and the groff_char(7)
N: manual page for details.
N:
N: Severity: wishlist, Certainty: possible
N:
N: Check: manpages, Type: binary
N:
I: swift: hyphen-used-as-minus-sign usr/share/man/man1/swift-orphans.1.gz:34
I: swift: hyphen-used-as-minus-sign usr/share/man/man1/swift-orphans.1.gz:41
W: swift: binary-without-manpage usr/bin/swift-bench-client
W: swift: binary-without-manpage usr/bin/swift-form-signature
W: swift: binary-without-manpage usr/bin/swift-oldies
W: swift: binary-without-manpage usr/bin/swift-recon
W: swift: binary-without-manpage usr/bin/swift-temp-url
I: swift-container: hyphen-used-as-minus-sign usr/share/man/man1/swift-container-auditor.1.gz:28
I: swift-container: hyphen-used-as-minus-sign usr/share/man/man1/swift-container-replicator.1.gz:28
I: swift-container: hyphen-used-as-minus-sign usr/share/man/man1/swift-container-server.1.gz:28
I: swift-container: hyphen-used-as-minus-sign usr/share/man/man1/swift-container-sync.1.gz:28
I: swift-container: hyphen-used-as-minus-sign usr/share/man/man1/swift-container-updater.1.gz:28
W: swift-container: manpage-has-errors-from-man usr/share/man/man5/container-server.conf.5.gz 218: warning: numeric expression expected (got `)')
N:
N: This man page provokes warnings or errors from man.
N:
N: "cannot adjust" or "can't break" are trouble with paragraph filling,
N: usually related to long lines. Adjustment can be helped by left
N: justifying, breaks can be helped with hyphenation, see "Manipulating
N: Filling and Adjusting" and "Manipulating Hyphenation" in the manual.
N:
N: "can't find numbered character" usually means latin1 etc in the input,
N: and this warning indicates characters will be missing from the output.
N: You can change to escapes like \[:a] described on the groff_char man
N: page.
N:
N: Other warnings are often formatting typos, like missing quotes around a
N: string argument to .IP. These are likely to result in lost or malformed
N: output. See the groff_man (or groff_mdoc if using mdoc) man page for
N: information on macros.
N:
N: This test uses man's --warnings option to enable groff warnings that
N: catch common mistakes, such as putting . or ' characters at the start of
N: a line when they are intended as literal text rather than groff
N: commands. This can be fixed either by reformatting the paragraph so that
N: these characters are not at the start of a line, or by adding a
N: zero-width space (\&) immediately before them.
N:
N: At worst, warning messages can be disabled with the .warn directive, see
N: "Debugging" in the groff manual.
N:
N: Lintian also stricter in regards to declaring manpage preprocessors.
N:
N: To test this for yourself you can use the following command:
N: LC_ALL=en_US.UTF-8 MANROFFSEQ='' MANWIDTH=80 \
N: man --warnings -E UTF-8 -l -Tutf8 -Z <file> >/dev/null
N:
N: Severity: normal, Certainty: certain
N:
N: Check: manpages, Type: binary
N:
I: swift-account: hyphen-used-as-minus-sign usr/share/man/man1/swift-account-auditor.1.gz:28
I: swift-account: hyphen-used-as-minus-sign usr/share/man/man1/swift-account-reaper.1.gz:28
I: swift-account: hyphen-used-as-minus-sign usr/share/man/man1/swift-account-replicator.1.gz:28
I: swift-account: hyphen-used-as-minus-sign usr/share/man/man1/swift-account-server.1.gz:28
I: swift-object: hyphen-used-as-minus-sign usr/share/man/man1/swift-object-auditor.1.gz:28
I: swift-object: hyphen-used-as-minus-sign usr/share/man/man1/swift-object-expirer.1.gz:28
I: swift-object: hyphen-used-as-minus-sign usr/share/man/man1/swift-object-server.1.gz:28
I: swift-object: hyphen-used-as-minus-sign usr/share/man/man1/swift-object-updater.1.gz:28
W: swift-object: manpage-has-errors-from-man usr/share/man/man1/swift-recon.1.gz 87: warning [p 2, 2.2i, div `an-div', 0.0i]: can't break line
I: swift-object: hyphen-used-as-minus-sign usr/share/man/man1/swift-recon.1.gz:28
I: swift-object: hyphen-used-as-minus-sign usr/share/man/man1/swift-recon.1.gz:72
W: swift-object: manpage-has-errors-from-man usr/share/man/man5/object-server.conf.5.gz 228: warning: numeric expression expected (got `)')
W: swift-object: binary-without-manpage usr/bin/swift-recon-cron
I: swift-proxy: hyphen-used-as-minus-sign usr/share/man/man1/swift-proxy-server.1.gz:28
W: swift-proxy: manpage-has-errors-from-man usr/share/man/man5/proxy-server.conf.5.gz 465: warning: numeric expression expected (got `)')
Reviewed: https:/ /review. openstack. org/43949 github. com/openstack/ swift/commit/ 83a6ec1683fa082 4d82a889046132a 7ac33463a8
Committed: http://
Submitter: Jenkins
Branch: master
commit 83a6ec1683fa082 4d82a889046132a 7ac33463a8
Author: Tobias Stevenson <email address hidden>
Date: Tue Aug 27 16:03:58 2013 -0500
Man page lintian errors and warnings
Used groff to recreate the errors. I believe all the issues without- manpage` are solved. Would like
except `binary-
confirmation from someone using Lintian.
Closes-Bug: #1210114 cdf3645cc3e3dc4 87f9ee5640a
Change-Id: I533205c53efdb7