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

lintian warnings about man pages' whatis entries

    • Type: Icon: Bug Bug
    • Resolution: Done
    • Priority: Icon: Minor - P4 Minor - P4
    • 1.3.0-beta0
    • Affects Version/s: None
    • Component/s: Docs
    • None

      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.
      

            Assignee:
            jesse@mongodb.com A. Jesse Jiryu Davis
            Reporter:
            jesse@mongodb.com A. Jesse Jiryu Davis
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: