[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#573837: lintian: [checks/manpages] [PATCH] improved checks/manpages.desc::manpage-has-bad-whatis-entry



Package: lintian
Version: 2.3.3
Severity: wishlist
Tags: patch

The patch:

- Explain TH and NAME problems in more detail (what to look for)
- Use parentheses to refer to program names: whatis(1). Tools,
  can use the information to manual pgae entries for programs 
  from the listing.

-- System Information:
Debian Release: squeeze/sid
  APT prefers testing
  APT policy: (990, 'testing'), (500, 'unstable'), (1, 'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 2.6.32-trunk-amd64 (SMP w/2 CPU cores)
Locale: LANG=en_DK.UTF-8, LC_CTYPE=en_DK.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages lintian depends on:
ii  binutils               2.20.1-2          The GNU assembler, linker and bina
ii  diffstat               1.47-1            produces graph of changes introduc
ii  dpkg-dev               1.15.5.6          Debian package development tools
ii  file                   5.04-1            Determines file type using "magic"
ii  gettext                0.17-9            GNU Internationalization utilities
ii  intltool-debian        0.35.0+20060710.1 Help i18n of RFC822 compliant conf
ii  libapt-pkg-perl        0.1.24            Perl interface to libapt-pkg
ii  libclass-accessor-perl 0.34-1            Perl module that automatically gen
ii  libipc-run-perl        0.84-1            Perl module for running processes
ii  libparse-debianchangel 1.1.1-2           parse Debian changelogs and output
ii  libtimedate-perl       1.2000-1          collection of modules to manipulat
ii  liburi-perl            1.52-1            module to manipulate and access UR
ii  locales                2.10.2-6          Embedded GNU C Library: National L
ii  man-db                 2.5.7-1           on-line manual pager
ii  perl [libdigest-sha-pe 5.10.1-11         Larry Wall's Practical Extraction 

lintian recommends no packages.

Versions of packages lintian suggests:
pn  binutils-multiarch            <none>     (no description available)
ii  libtext-template-perl         1.45-1     Text::Template perl module
ii  man-db                        2.5.7-1    on-line manual pager

-- no debconf information
>From 0d1c36b68a233c34fa1fb54e4383fa66d36b9bb2 Mon Sep 17 00:00:00 2001
From: Jari Aalto <jari.aalto@cante.net>
Date: Thu, 11 Mar 2010 09:52:13 +0200
Subject: [PATCH] checks/manpages.desc: (manpage-has-bad-whatis-entry): explain more about TH NAME problems

Signed-off-by: Jari Aalto <jari.aalto@cante.net>
---
 checks/manpages.desc |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/checks/manpages.desc b/checks/manpages.desc
index 2a3de77..28bacfb 100644
--- a/checks/manpages.desc
+++ b/checks/manpages.desc
@@ -103,9 +103,11 @@ Tag: manpage-has-bad-whatis-entry
 Severity: normal
 Certainty: certain
 Info: Each manual page should start with a "NAME" section, which lists the
- name and a brief description of the page separated by "\-". These sections
- are parsed by "mandb" and stored in a database for the use of "apropos" and
- "whatis", so they must be in a certain format. This manual page apparently
+ name and a brief description of the page separated by "\-". A common mistake
+ is that in sections TH or NAME the entry is expressed with a space in form
+ "PROGRAM NAME", not "PROGRAM_NAME" or "PROGRAM-NAME". The TH and NAME sections
+ are parsed by mandb(8) and stored in a database for the use of apropos(1) and
+ whatis(1), so they must be in a certain format. This manual page apparently
  uses the wrong format and cannot be parsed by "mandb".
 Ref: lexgrog(1), groff_man(7), groff_mdoc(7)
 
-- 
1.7.0


Reply to: