[CDRIVER-4765] Investigate Lintian warning 'bad-whatis-entry' Created: 01/Nov/23  Updated: 07/Nov/23

Status: Backlog
Project: C Driver
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Unknown
Reporter: Kyle Kloberdanz Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

During Debian packaging, Lintian uncovered 937 warnings for the following:

 

W: libbson-doc: bad-whatis-entry [usr/share/man/man3/bson_aligned_alloc.3.gz]
N:
N:   A manual page should start with a NAME section, which lists the program
N:   name and a brief description. The NAME section is used to generate a
N:   database that can be queried by commands like apropos and whatis. You are
N:   seeing this tag because lexgrog was unable to parse the NAME section.
N:
N:   Manual pages for multiple programs, functions, or files should list each
N:   separated by a comma and a space, followed by - and a common description.
N:
N:   Listed items may not contain any spaces. A manual page for a two-level
N:   command such as fs listacl must look like fs_listacl so the list is read
N:   correctly.
N:
N:   Please refer to the lexgrog(1) manual page, the groff_man(7) manual page,
N:   and the groff_mdoc(7) manual page for details.
N:
N:   Visibility: warning
N:   Show-Always: no
N:   Check: documentation/manual
N:   Renamed from: manpage-has-bad-whatis-entry



 Comments   
Comment by Kyle Kloberdanz [ 01/Nov/23 ]

Possibly related to: https://github.com/mongodb/mongo-c-driver/pull/1354

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