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

lintian warnings about hyphens in man pages

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

      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
      

            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: