Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-4765

Investigate Lintian warning 'bad-whatis-entry'

    XMLWordPrintableJSON

Details

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Unknown Unknown
    • None
    • None
    • None
    • None

    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

      Attachments

        Activity

          People

            Unassigned Unassigned
            kyle.kloberdanz@mongodb.com Kyle Kloberdanz
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated: