[PATCH] Add a concise summary of grub-install to it's usage information

[Andrew Worsley]

Example patch grub-install - This is the sort of

change I am proposing. I am not sure if this will survive gmail mangling but comments welcome as this is just a proposal for feed back.

Andrew 

This usage information will appear in it's generated man file and make it a lot more

informative

---

 util/grub-install.c | 24 +++++++++++++++++++++---

 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/util/grub-install.c b/util/grub-install.c

index 6c89c2b..b7306ee 100644

--- a/util/grub-install.c

+++ b/util/grub-install.c

@@ -359,10 +359,28 @@ help_filter (int key, const char *text, void *input __attribute__ ((unused)))

    install to.  */

 struct argp argp = {

   options, argp_parser, N_("[OPTION] [INSTALL_DEVICE]"),

-  N_("Install GRUB on your drive.")"\v"

+  N_("Install GRUB on the INSTALL_DEVICE drive."

+  " Firstly it installs all modules and the generated boot menu script grub.cfg"

+  " into the specified boot directory on INSTALL_DEVICE. When booting grub"

+  " will read the grub.cfg script and load any modules it requests. These modules"

+  " provide grub with extra functionalty such as graphics or the ability to read"

+  " other filesystems on different devices. This allows grub to finally load the"

+  " selected operating system. Secondly it will generate a core.img binary"

+  " that can read the file system of the INSTALL_DEVICE and load"

+  " files from it. This allows core.img to read and load the modules and scripts"

+  " from /boot/grub. Then the grub-setup command is invoked to store core.img"

+  " so that it is run by the system dependant boot process.")

+

+    "\v"

   N_("INSTALL_DEVICE must be system device filename.\n"

-     "%s copies GRUB images into %s.  On some platforms, it"

-     " may also install GRUB into the boot sector."), 

+     "%s copies GRUB images into the boot directory %s.  On some platforms, it"

+     " may also install GRUB into the boot sector. On legacy BIOS systems this"

+     " is typically \"embedded\" in the 32K of blocks directly after the MBR"

+     " or another dedicated partition. On EFI systems this may be a dedicated"

+     " FAT partition or HFS+ partition for MAC based systems."

+     " "

+     " For more details run \"info grub Installation\""

+     ),

   NULL, help_filter, NULL

 };

 

-- 

2.1.4