[PATCH] Fix up grub-mkimage help2man output

[PATCH] Fix up grub-mkimage help2man output

[Colin Watson]

grub-mkimage's help2man output is messed up for a couple of targets;
option lines in help text need to start with two spaces for help2man to
recognise them as options rather than as flowing text. Most of GRUB gets
this right, but a few places don't.

Index: ChangeLog
===================================================================
--- ChangeLog	(revision 2334)
+++ ChangeLog	(working copy)
@@ -1,3 +1,9 @@
+2009-06-17  Colin Watson  <cjwatson@ubuntu.com>
+
+	* util/elf/grub-mkimage.c (usage): Prefix each option line with two
+	spaces, for the benefit of help2man.
+	* util/i386/efi/grub-mkimage.c (usage): Likewise.
+
 2009-06-16  Pavel Roskin  <proski@gnu.org>
 
 	* kern/i386/halt.c: Include grub/machine/init.h.
Index: util/elf/grub-mkimage.c
===================================================================
--- util/elf/grub-mkimage.c	(revision 2334)
+++ util/elf/grub-mkimage.c	(working copy)
@@ -332,14 +332,14 @@
 \n\
 Make a bootable image of GRUB.\n\
 \n\
--d, --directory=DIR     use images and modules under DIR [default=%s]\n\
--p, --prefix=DIR        set grub_prefix directory\n\
--m, --memdisk=FILE      embed FILE as a memdisk image\n\
--o, --output=FILE       output a generated image to FILE\n\
--h, --help              display this message and exit\n\
--n, --note              add NOTE segment for CHRP Open Firmware\n\
--V, --version           print version information and exit\n\
--v, --verbose           print verbose messages\n\
+  -d, --directory=DIR     use images and modules under DIR [default=%s]\n\
+  -p, --prefix=DIR        set grub_prefix directory\n\
+  -m, --memdisk=FILE      embed FILE as a memdisk image\n\
+  -o, --output=FILE       output a generated image to FILE\n\
+  -h, --help              display this message and exit\n\
+  -n, --note              add NOTE segment for CHRP Open Firmware\n\
+  -V, --version           print version information and exit\n\
+  -v, --verbose           print verbose messages\n\
 \n\
 Report bugs to <%s>.\n\
 ", GRUB_LIBDIR, PACKAGE_BUGREPORT);
Index: util/i386/efi/grub-mkimage.c
===================================================================
--- util/i386/efi/grub-mkimage.c	(revision 2334)
+++ util/i386/efi/grub-mkimage.c	(working copy)
@@ -1069,12 +1069,12 @@
 \n\
 Make a bootable image of GRUB.\n\
 \n\
--d, --directory=DIR     use images and modules under DIR [default=%s]\n\
--p, --prefix=DIR        set grub_prefix directory [default=%s]\n\
--o, --output=FILE       output a generated image to FILE\n\
--h, --help              display this message and exit\n\
--V, --version           print version information and exit\n\
--v, --verbose           print verbose messages\n\
+  -d, --directory=DIR     use images and modules under DIR [default=%s]\n\
+  -p, --prefix=DIR        set grub_prefix directory [default=%s]\n\
+  -o, --output=FILE       output a generated image to FILE\n\
+  -h, --help              display this message and exit\n\
+  -V, --version           print version information and exit\n\
+  -v, --verbose           print verbose messages\n\
 \n\
 Report bugs to <%s>.\n\
 ", GRUB_LIBDIR, DEFAULT_DIRECTORY, PACKAGE_BUGREPORT);

Thanks,

-- 
Colin Watson                                       [cjwatson@ubuntu.com]

Re: [PATCH] Fix up grub-mkimage help2man output

[Felix Zielcke]

Am Mittwoch, den 17.06.2009, 00:19 +0100 schrieb Colin Watson:
> 
> grub-mkimage's help2man output is messed up for a couple of targets;
> option lines in help text need to start with two spaces for help2man
> to
> recognise them as options rather than as flowing text. Most of GRUB
> gets
> this right, but a few places don't.

Thanks Colin. I just commited it.
-- 
Felix Zielcke