[CDRIVER-863] lintian warnings about man pages' whatis entries 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 about "manpage-has-bad-whatis-entry" in the man pages that mallard2man.py generates from our .page files. Same will happen in libmongoc.

Warning's description:

Each manual page should start with a "NAME" section, which lists
the name and a brief description of the page separated by "\-".
The "NAME" section is parsed by lexgrog and used to generate a
database that's queried by commands like apropos and whatis. This
tag indicates that lexgrog was unable to parse the NAME section
of this manual page.
 
For manual pages that document multiple programs, functions,
files, or other things, the part before "\-" should list each
separated by a comma and a space. Each thing listed must not
contain spaces; a man page for a two-part command like "fs
listacl" must use something like "fs_listacl" in the "NAME"
section so that it can be parsed by lexgrog.



 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-863 whatis entries for all man pages

Format man page name like "name - description" so makewhatis adds it
to the system whatis database.

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

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-863 whatis entries for all man pages

Format man page name like "name - description" so makewhatis adds it
to the system whatis database.

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

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-863 whatis entries for all man pages

Format man page name like "name - description" so makewhatis adds it
to the system whatis database.

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

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-863 whatis entries for all man pages

Format man page name like "name - description" so makewhatis adds it
to the system whatis database.

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

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.