grub-devel
[Top][All Lists]
Advanced

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

Re: [PATCH] Improve man page headers


From: Jordi Mallach
Subject: Re: [PATCH] Improve man page headers
Date: Wed, 9 Jun 2010 18:02:44 +0200
User-agent: Mutt/1.5.20 (2009-06-14)

On Tue, Jun 08, 2010 at 06:46:56PM +0100, Colin Watson wrote:
> The following patch improves the man pages we generate by giving them
> decent NAME sections, which are included in indexes of man pages and so
> are worth getting right.  help2man's default is something like
> "grub-bin2h \- manual page for grub-bin2h (GRUB) 1.98" which is of
> course hopeless in an index.

What I do for Mailutils is extracting the NAME section on the fly. It's
not really robust, as a change in the help output can break it (although
lintian would probably nag us really quickly), but the problem with this
approach is that if the description changes in the program, it needs to be
manually updated in the h2m helpers.

http://svn.debian.org/viewsvn/pkg-mailutils/trunk/debian/mangen.sh?revision=348&view=markup

Jordi
-- 
Jordi Mallach Pérez  --  Debian developer     http://www.debian.org/
address@hidden     address@hidden     http://www.sindominio.net/
GnuPG public key information available at http://oskuro.net/

Attachment: signature.asc
Description: Digital signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]