From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mailman by lists.gnu.org with archive (Exim 4.43) id 1OMR4e-0000w9-Bl for mharc-grub-devel@gnu.org; Wed, 09 Jun 2010 15:36:28 -0400 Received: from [140.186.70.92] (port=36848 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OMR4Z-0000tG-KD for grub-devel@gnu.org; Wed, 09 Jun 2010 15:36:26 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OMR4W-0005vL-OG for grub-devel@gnu.org; Wed, 09 Jun 2010 15:36:22 -0400 Received: from mail-fx0-f41.google.com ([209.85.161.41]:55622) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OMR4W-0005vD-Gt for grub-devel@gnu.org; Wed, 09 Jun 2010 15:36:20 -0400 Received: by fxm14 with SMTP id 14so4424678fxm.0 for ; Wed, 09 Jun 2010 12:36:19 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:received:received:message-id:date:from :user-agent:mime-version:to:subject:references:in-reply-to :x-enigmail-version:content-type; bh=sGOMNNmssHgbWuoiXDI9vRDJXrcnVOAplQZTBh8YioQ=; b=hv1zo49jjBeRBIddsxORs0wQNUDGx3+FMDKQpXDptcPM3aWBl8NK4GqEf42QvsllZX NzOuX4Pf9TJq1x0pF+ZRVPnl1Efj7oSCn0tuJZGQhT2syXYYTbL6KQEbytOIMu46Upit QY3PxzE+XTLt4cDZzwutIn3lpkD80R6Bz/Xpg= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=message-id:date:from:user-agent:mime-version:to:subject:references :in-reply-to:x-enigmail-version:content-type; b=IqaRM2440GFJ4PnxrDxhjAp6eU4bjbDwAKroFhfmvL9Ie2ft+ZiNijXAKd2cbvGD3q dw+0YENJidRtG6jDU1W1uZHudrJmYXes93XUjzPO0tttUn0VyQrWgEFh976hO/TFgNRr 1hnyBveuRz3kHKg23e1Kl0+9XL1I8ZmCzaVCg= Received: by 10.204.160.147 with SMTP id n19mr1520535bkx.66.1276112178920; Wed, 09 Jun 2010 12:36:18 -0700 (PDT) Received: from debian.bg45.phnet (gprs41.swisscom-mobile.ch [193.247.250.41]) by mx.google.com with ESMTPS id v14sm30871591bkz.14.2010.06.09.12.36.13 (version=TLSv1/SSLv3 cipher=RC4-MD5); Wed, 09 Jun 2010 12:36:17 -0700 (PDT) Message-ID: <4C0FED26.1030906@gmail.com> Date: Wed, 09 Jun 2010 21:36:06 +0200 From: =?UTF-8?B?VmxhZGltaXIgJ8+GLWNvZGVyL3BoY29kZXInIFNlcmJpbmVua28=?= User-Agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.9) Gecko/20100515 Icedove/3.0.4 MIME-Version: 1.0 To: The development of GNU GRUB References: <20100608174656.GU21862@riva.ucam.org> In-Reply-To: <20100608174656.GU21862@riva.ucam.org> X-Enigmail-Version: 1.0.1 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="------------enigC3EC10A788D6059C67C3105E" X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) Subject: Re: [PATCH] Improve man page headers X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list Reply-To: The development of GNU GRUB List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 09 Jun 2010 19:36:26 -0000 This is an OpenPGP/MIME signed message (RFC 2440 and 3156) --------------enigC3EC10A788D6059C67C3105E Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable On 06/08/2010 07:46 PM, 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. > > I know that the GNU Coding Standards do not recommend putting lots of > effort into manual pages, although they don't forbid doing so either - > see http://www.gnu.org/prep/standards/standards.html#Man-Pages. In thi= s > case, I haven't, and I don't think this is a big maintenance burden, > just a set of tweaks on top of most of the work being done by help2man > in order to make some warnings emitted by Debian's package checker go > away. That said, I maintain the man-db package and I'm more than happy= > to maintain GRUB's manual pages insofar as they need maintaining if > that's a requirement. > > =20 This doesn't seem likely to be a maintenance burden so go ahead. > 2010-06-08 Colin Watson > > * Makefile.in (install-local): Include $(srcdir)/docs/man/$$dest.h2m > when generating manual pages. > * docs/man/grub-bin2h.h2m: New file. > * docs/man/grub-editenv.h2m: New file. > * docs/man/grub-fstest.h2m: New file. > * docs/man/grub-install.h2m: New file. > * docs/man/grub-macho2img.h2m: New file. > * docs/man/grub-mkconfig.h2m: New file. > * docs/man/grub-mkdevicemap.h2m: New file. > * docs/man/grub-mkfont.h2m: New file. > * docs/man/grub-mkimage.h2m: New file. > * docs/man/grub-mkpasswd-pbkdf2.h2m: New file. > * docs/man/grub-mkrelpath.h2m: New file. > * docs/man/grub-mkrescue.h2m: New file. > * docs/man/grub-ofpathname.h2m: New file. > * docs/man/grub-pe2elf.h2m: New file. > * docs/man/grub-probe.h2m: New file. > * docs/man/grub-reboot.h2m: New file. > * docs/man/grub-script-check.h2m: New file. > * docs/man/grub-set-default.h2m: New file. > * docs/man/grub-setup.h2m: New file. > > =3D=3D=3D modified file 'Makefile.in' > --- Makefile.in 2010-05-18 11:55:26 +0000 > +++ Makefile.in 2010-06-08 17:25:15 +0000 > @@ -323,26 +323,26 @@ install-local: all > if test -f "$$file"; then dir=3D; else dir=3D"$(srcdir)/"; fi; \ > dest=3D"`echo $$file | sed 's,.*/,,' | sed '$(transform)'`"; \ > $(INSTALL_PROGRAM) $$dir$$file $(DESTDIR)$(bindir)/$$dest; \ > - $(HELP2MAN) --section=3D1 -o $(DESTDIR)$(mandir)/man1/$$dest.1 $(bu= ilddir)/$$file; \ > + $(HELP2MAN) --section=3D1 -i $(srcdir)/docs/man/$$dest.h2m -o $(DES= TDIR)$(mandir)/man1/$$dest.1 $(builddir)/$$file; \ > done > $(SHELL) $(mkinstalldirs) $(DESTDIR)$(sbindir) $(DESTDIR)$(mandir)/ma= n8 > @list=3D'$(sbin_UTILITIES)'; for file in $$list; do \ > if test -f "$$file"; then dir=3D; else dir=3D"$(srcdir)/"; fi; \ > dest=3D"`echo $$file | sed 's,.*/,,' | sed '$(transform)'`"; \ > $(INSTALL_PROGRAM) $$dir$$file $(DESTDIR)$(sbindir)/$$dest; \ > - $(HELP2MAN) --section=3D8 -o $(DESTDIR)$(mandir)/man8/$$dest.8 $(bu= ilddir)/$$file; \ > + $(HELP2MAN) --section=3D8 -i $(srcdir)/docs/man/$$dest.h2m -o $(DES= TDIR)$(mandir)/man8/$$dest.8 $(builddir)/$$file; \ > done > @list=3D'$(bin_SCRIPTS)'; for file in $$list; do \ > if test -f "$$file"; then dir=3D; else dir=3D"$(srcdir)/"; fi; \ > dest=3D"`echo $$file | sed 's,.*/,,' | sed '$(transform)'`"; \ > $(INSTALL_SCRIPT) $$dir$$file $(DESTDIR)$(bindir)/$$dest; \ > - $(HELP2MAN) --section=3D1 -o $(DESTDIR)$(mandir)/man1/$$dest.1 $(bu= ilddir)/$$file; \ > + $(HELP2MAN) --section=3D1 -i $(srcdir)/docs/man/$$dest.h2m -o $(DES= TDIR)$(mandir)/man1/$$dest.1 $(builddir)/$$file; \ > done > @list=3D'$(sbin_SCRIPTS)'; for file in $$list; do \ > if test -f "$$file"; then dir=3D; else dir=3D"$(srcdir)/"; fi; \ > dest=3D"`echo $$file | sed 's,.*/,,' | sed '$(transform)'`"; \ > $(INSTALL_SCRIPT) $$dir$$file $(DESTDIR)$(sbindir)/$$dest; \ > - $(HELP2MAN) --section=3D8 -o $(DESTDIR)$(mandir)/man8/$$dest.8 $(bu= ilddir)/$$file; \ > + $(HELP2MAN) --section=3D8 -i $(srcdir)/docs/man/$$dest.h2m -o $(DES= TDIR)$(mandir)/man8/$$dest.8 $(builddir)/$$file; \ > done > $(SHELL) $(mkinstalldirs) $(DESTDIR)$(sysconfdir)/grub.d > @list=3D'$(grub-mkconfig_SCRIPTS)'; for file in $$list; do \ > > =3D=3D=3D added directory 'docs/man' > =3D=3D=3D added file 'docs/man/grub-bin2h.h2m' > --- docs/man/grub-bin2h.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-bin2h.h2m 2010-06-08 17:29:40 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-bin2h \- convert a binary file to a C header > > =3D=3D=3D added file 'docs/man/grub-editenv.h2m' > --- docs/man/grub-editenv.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-editenv.h2m 2010-06-08 17:30:31 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-editenv \- edit GRUB environment block > > =3D=3D=3D added file 'docs/man/grub-fstest.h2m' > --- docs/man/grub-fstest.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-fstest.h2m 2010-06-08 17:28:12 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-fstest \- debug tool for GRUB filesystem drivers > > =3D=3D=3D added file 'docs/man/grub-install.h2m' > --- docs/man/grub-install.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-install.h2m 2010-06-08 17:34:51 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-install \- install GRUB to a device > > =3D=3D=3D added file 'docs/man/grub-macho2img.h2m' > --- docs/man/grub-macho2img.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-macho2img.h2m 2010-06-08 17:31:07 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-macho2img \- convert Mach-O to raw image > > =3D=3D=3D added file 'docs/man/grub-mkconfig.h2m' > --- docs/man/grub-mkconfig.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-mkconfig.h2m 2010-06-08 17:33:21 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-mkconfig \- generate a GRUB configuration file > > =3D=3D=3D added file 'docs/man/grub-mkdevicemap.h2m' > --- docs/man/grub-mkdevicemap.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-mkdevicemap.h2m 2010-06-08 17:27:47 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-mkdevicemap \- generate a GRUB device map file automatically > > =3D=3D=3D added file 'docs/man/grub-mkfont.h2m' > --- docs/man/grub-mkfont.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-mkfont.h2m 2010-06-08 17:28:47 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-mkfont \- make GRUB font files > > =3D=3D=3D added file 'docs/man/grub-mkimage.h2m' > --- docs/man/grub-mkimage.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-mkimage.h2m 2010-06-08 17:26:37 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-mkimage \- make a bootable image of GRUB > > =3D=3D=3D added file 'docs/man/grub-mkpasswd-pbkdf2.h2m' > --- docs/man/grub-mkpasswd-pbkdf2.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-mkpasswd-pbkdf2.h2m 2010-06-08 17:32:13 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-mkpasswd-pbkdf2 \- generate hashed password for GRUB > > =3D=3D=3D added file 'docs/man/grub-mkrelpath.h2m' > --- docs/man/grub-mkrelpath.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-mkrelpath.h2m 2010-06-08 17:29:13 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-mkrelpath \- make a system path relative to its root > > =3D=3D=3D added file 'docs/man/grub-mkrescue.h2m' > --- docs/man/grub-mkrescue.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-mkrescue.h2m 2010-06-08 17:35:04 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-mkrescue \- make a GRUB rescue image > > =3D=3D=3D added file 'docs/man/grub-ofpathname.h2m' > --- docs/man/grub-ofpathname.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-ofpathname.h2m 2010-06-08 17:35:57 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-ofpathname \- find OpenBOOT path for a device > > =3D=3D=3D added file 'docs/man/grub-pe2elf.h2m' > --- docs/man/grub-pe2elf.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-pe2elf.h2m 2010-06-08 17:31:28 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-pe2elf \- convert PE image to ELF > > =3D=3D=3D added file 'docs/man/grub-probe.h2m' > --- docs/man/grub-probe.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-probe.h2m 2010-06-08 17:27:13 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-probe \- probe device information for GRUB > > =3D=3D=3D added file 'docs/man/grub-reboot.h2m' > --- docs/man/grub-reboot.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-reboot.h2m 2010-06-08 17:34:12 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-reboot \- set the default boot entry for GRUB, for the next boot = only > > =3D=3D=3D added file 'docs/man/grub-script-check.h2m' > --- docs/man/grub-script-check.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-script-check.h2m 2010-06-08 17:30:11 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-script-check \- check grub.cfg for syntax errors > > =3D=3D=3D added file 'docs/man/grub-set-default.h2m' > --- docs/man/grub-set-default.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-set-default.h2m 2010-06-08 17:33:50 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-set-default \- set the default boot entry for GRUB > > =3D=3D=3D added file 'docs/man/grub-setup.h2m' > --- docs/man/grub-setup.h2m 1970-01-01 00:00:00 +0000 > +++ docs/man/grub-setup.h2m 2010-06-08 17:32:59 +0000 > @@ -0,0 +1,2 @@ > +[NAME] > +grub-setup \- set up a device to boot using GRUB > > =20 --=20 Regards Vladimir '=CF=86-coder/phcoder' Serbinenko --------------enigC3EC10A788D6059C67C3105E Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.10 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iF4EAREKAAYFAkwP7SYACgkQNak7dOguQgmmXgD+KeDey5VuUVArzbx+/9kZcWex VVMwXTndtc4VSMQxcZcA/3PPxAkGE4NDhXBgrlk4fsK3r2XyNfr7w8HXZ2VRg2CW =B98j -----END PGP SIGNATURE----- --------------enigC3EC10A788D6059C67C3105E--