'hyphen-used-as-minus-sign' lintian warning
Hi,
I got a hyphen-used-as-minus-sign lintian warning. The cited manpage
(see below) is generated by doxygen.
I couldn't think on a reasonable way of fixing that, and couldn't find
any tip in the web.
All the three ocurrances mean "-1" as a return code in methods
documentation, but changing the source code for this isn't reasonable to
me. Should I ...
* escape the hyphens manually with sed during build?
* try to make doxygen do the "right thing" with those hyphen's ?
* anything else?
If someone cares, the package (0.5.2) can be found at
http://mentors.debian.net/debian/pool/main/p/pstreams/
Follows lintian's output:
terceiro@boipeba:~/src/pstreams$ lintian -iI pstreams_0.5.2-1_i386.changes
I: libpstreams-dev: hyphen-used-as-minus-sign usr/share/man/man3/redi_basic_pstreambuf.3.gz:376
N:
N: Manual page seems to contain a hyphen where a minus sign was intended.
N: '-' chars are interpreted as hyphens (U+2010) by groff, not as minus
N: signs (U+002D). Since options to programs use minus signs (U+002D),
N: this means for example in UTF-8 locales that you cannot cut&paste
N: options, nor search for them easily.
N:
N: '-' must be escaped ('\-') to be interpreted as minus. If you really
N: intend a hyphen, write it as '\(hy' to emphasise that fact. See
N: groff(7) and especially groff_char(7) for details, and also the thread
N: starting with
N: http://lists.debian.org/debian-devel/2003/debian-devel-200303/msg01481
N: .html
N:
N: If you use some tool that converts your documentation to groff format,
N: it might be possible that this tool converts dashes of any kind to
N: groff hyphens, while the safe way of converting dashes is usually to
N: convert them to '\-'.
N:
N: Because this error can occur very often we show 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:
I: libpstreams-dev: hyphen-used-as-minus-sign usr/share/man/man3/redi_basic_pstreambuf.3.gz:583
I: libpstreams-dev: hyphen-used-as-minus-sign usr/share/man/man3/redi_basic_pstreambuf.3.gz:617
--
Antonio S. de A. Terceiro <asaterceiro@inf.ufrgs.br>
http://www.inf.ufrgs.br/~asaterceiro
GnuPG ID: E6F73C30
Reply to: