Skip to contentSkip to conversation

Fix up grub-mkimage help2man output

PATCH In review Colin Watson 2 participants 2 messages Jun 16, 2009 – Jun 17, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Fix up grub-mkimage help2man output

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.

ChangeLog +6 -0
Index: ChangeLog
===================================================================
@@ -1,3 +1,9 @@
+2009-06-17  Colin Watson  <[email protected]>
+
+	* 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  <[email protected]>
 
 	* kern/i386/halt.c: Include grub/machine/init.h.
elf/grub-mkimage.c +8 -8
Index: util/elf/grub-mkimage.c
===================================================================
@@ -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);
i386/efi/grub-mkimage.c +6 -6
Index: util/i386/efi/grub-mkimage.c
===================================================================
@@ -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,

Signature · 1 line
Colin Watson                                       [[email protected]]
#1 lore raw

Am Mittwoch, den 17.06.2009, 00:19 +0100 schrieb Colin Watson:

Quoted 7 lines

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.

Signature · 1 line
Felix Zielcke