[CDRIVER-862] lintian warnings about hyphens in man pages Created: 19/Sep/15  Updated: 11/Jan/16  Resolved: 12/Oct/15

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.3.0-beta0

Type: Bug Priority: Minor - P4
Reporter: A. Jesse Jiryu Davis Assignee: A. Jesse Jiryu Davis
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Epic Link: Debian packaging

 Description   

When running lintian (the Debian package linter) on libbson, it warns copiously about "hyphen-used-as-minus-sign" in the man pages that mallard2man.py generates from our .page files. Same will happen in libmongoc.

Warning's description:

This manual page seems to contain a hyphen where a minus sign was
intended. By default, "-" chars are interpreted as
hyphens (U+2010) by groff, not as minus signs (U+002D). Since
options to programs use minus signs (U+002D), this means for
example in UTF-8 locales that you cannot cut and paste options,
nor search for them easily. The Debian groff package currently
forces "-" to be interpreted as a minus sign due to the number of
manual pages with this problem, but this is a Debian-specific
modification and hopefully eventually can be removed.
 
"-" must be escaped ("\-") to be interpreted as minus. If you
really intend a hyphen (normally you don't), write it as "\(hy"
to emphasise that fact. See groff(7) and especially groff_char(7)
for details, and also the thread starting with
http://lists.debian.org/debian-devel/2003/debian-devel-200303/msg01481.html



 Comments   
Comment by Githook User [ 11/Jan/16 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: Merge branch 'master' into r1.2

Comment by Githook User [ 11/Jan/16 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-862 escape hyphens in man pages

Format hyphens like "(hy".

Avoids lintian warning "manpage-has-bad-whatis-entry".
Branch: 1.3.0-dev
https://github.com/mongodb/libbson/commit/75766c7350c888b042e595dd8914c5d05e7aa2d1

Comment by Githook User [ 22/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: Merge branch 'master' into r1.2

Comment by Githook User [ 20/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: Merge branch 'master' into r1.2

Comment by Githook User [ 20/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-862 escape hyphens in man pages

Format hyphens like "(hy".

Avoids lintian warning "manpage-has-bad-whatis-entry".
Branch: debian
https://github.com/mongodb/libbson/commit/75766c7350c888b042e595dd8914c5d05e7aa2d1

Comment by Githook User [ 20/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: Merge branch 'master' into r1.2

Comment by Githook User [ 20/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-862 escape hyphens in man pages

Format hyphens like "(hy".

Avoids lintian warning "manpage-has-bad-whatis-entry".
Branch: r1.2
https://github.com/mongodb/libbson/commit/75766c7350c888b042e595dd8914c5d05e7aa2d1

Comment by Githook User [ 12/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: CDRIVER-862 escape hyphens in man pages

Format hyphens like "(hy".

Avoids lintian warning "manpage-has-bad-whatis-entry".
Branch: master
https://github.com/mongodb/libbson/commit/75766c7350c888b042e595dd8914c5d05e7aa2d1

Comment by Githook User [ 12/Oct/15 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: update mallard2man.py from libbson

Recent fixes:

Generated at Wed Feb 07 21:10:50 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.