All of lore.kernel.org
 help / color / mirror / Atom feed
From: Colin Watson <cjwatson@ubuntu.com>
To: grub-devel@gnu.org
Subject: [PATCH] Fix up grub-mkimage help2man output
Date: Wed, 17 Jun 2009 00:19:09 +0100	[thread overview]
Message-ID: <20090616231908.GU7367@riva.ucam.org> (raw)

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]



             reply	other threads:[~2009-06-16 23:19 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-06-16 23:19 Colin Watson [this message]
2009-06-17  6:07 ` [PATCH] Fix up grub-mkimage help2man output Felix Zielcke

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20090616231908.GU7367@riva.ucam.org \
    --to=cjwatson@ubuntu.com \
    --cc=grub-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.