Re: [PATCH] Clean up dangling references to grub-setup

["Vladimir 'φ-coder/phcoder' Serbinenko" <phcoder@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 7904 bytes --]

On 07.01.2013 11:54, Colin Watson wrote:

> On Thu, Jan 03, 2013 at 06:13:11PM +0100, Vladimir 'φ-coder/phcoder' Serbinenko wrote:
>> On 02.01.2013 18:18, Colin Watson wrote:
>>
>>> https://bugs.launchpad.net/ubuntu/+source/grub2/+bug/1082045 notes a
>>> dangling documentation reference to grub-setup, and I found several
>>> others.  This patch cleans them up as best I can manage; it would be a
>>> little better if the .h2m files could contain architecture-specific
>>> substitutions, but I think this is good enough.
>>
>> In general it's better to avoid mentionning grub-*-setup in user docs at
>> all. Such info is inner workings and belongs to dev docs.
> 
> OK.  How about this?

Good. Go ahead.

> 
> 2013-01-07  Colin Watson  <cjwatson@ubuntu.com>
> 
> 	* docs/grub.texi (Images): Refer generally to grub-install rather
> 	than directly to grub-setup.
> 	(Installing GRUB using grub-install): Remove direct reference to
> 	grub-setup.
> 	(Device map) Likewise.
> 	(Invoking grub-install): Likewise.
> 	* docs/man/grub-install.h2m (SEE ALSO): Likewise.
> 	* docs/man/grub-mkimage.h2m (SEE ALSO): Likewise.
> 	* util/grub-install.in (usage): Likewise.
> 
> 	* util/bash-completion.d/grub-completion.bash.in (_grub_setup):
> 	Apply to grub-bios-setup and grub-sparc64-setup rather than to
> 	grub-setup.
> 	* configure.ac: Remove grub_setup output variable.
> 
> 	* docs/man/grub-bios-setup.h2m (NAME): Change name from grub-setup
> 	to grub-bios-setup.
> 	* docs/man/grub-sparc64-setup.h2m (NAME): Change name from
> 	grub-setup to grub-sparc64-setup.
> 
> === modified file 'configure.ac'
> --- configure.ac	2013-01-03 20:34:34 +0000
> +++ configure.ac	2013-01-07 10:34:22 +0000
> @@ -64,7 +64,6 @@ grub_TRANSFORM([grub-probe])
>  grub_TRANSFORM([grub-reboot])
>  grub_TRANSFORM([grub-script-check])
>  grub_TRANSFORM([grub-set-default])
> -grub_TRANSFORM([grub-setup])
>  grub_TRANSFORM([grub-sparc64-setup])
>  
>  # Optimization flag.  Allow user to override.
> 
> === modified file 'docs/grub.texi'
> --- docs/grub.texi	2013-01-07 10:43:00 +0000
> +++ docs/grub.texi	2013-01-07 10:48:40 +0000
> @@ -622,11 +622,11 @@ This install doesn't conflict with stand
>  separate directories.
>  
>  Note that @command{grub-install} is actually just a shell script and the
> -real task is done by @command{grub-mkimage} and @command{grub-setup}.
> -Therefore, you may run those commands directly to install GRUB, without
> -using @command{grub-install}. Don't do that, however, unless you are very
> -familiar with the internals of GRUB. Installing a boot loader on a running
> -OS may be extremely dangerous.
> +real task is done by other tools such as @command{grub-mkimage}. Therefore,
> +you may run those commands directly to install GRUB, without using
> +@command{grub-install}. Don't do that, however, unless you are very familiar
> +with the internals of GRUB. Installing a boot loader on a running OS may be
> +extremely dangerous.
>  
>  @node Making a GRUB bootable CD-ROM
>  @section Making a GRUB bootable CD-ROM
> @@ -688,8 +688,8 @@ storage devices.
>  @section The map between BIOS drives and OS devices
>  
>  If the device map file exists, the GRUB utilities (@command{grub-probe},
> -@command{grub-setup}, etc.) read it to map BIOS drives to OS devices.  This
> -file consists of lines like this:
> +etc.) read it to map BIOS drives to OS devices.  This file consists of lines
> +like this:
>  
>  @example
>  (@var{device}) @var{file}
> @@ -2283,8 +2283,8 @@ bytes.
>  The sole function of @file{boot.img} is to read the first sector of the core
>  image from a local disk and jump to it.  Because of the size restriction,
>  @file{boot.img} cannot understand any file system structure, so
> -@command{grub-setup} hardcodes the location of the first sector of the core
> -image into @file{boot.img} when installing GRUB.
> +@command{grub-install} hardcodes the location of the first sector of the
> +core image into @file{boot.img} when installing GRUB.
>  
>  @item diskboot.img
>  This image is used as the first sector of the core image when booting from a
> @@ -4689,9 +4689,9 @@ GRUB.
>  @node Invoking grub-install
>  @chapter Invoking grub-install
>  
> -The program @command{grub-install} installs GRUB on your drive using
> -@command{grub-mkimage} and (on some platforms) @command{grub-setup}.  You
> -must specify the device name on which you want to install GRUB, like this:
> +The program @command{grub-install} generates a GRUB core image using
> +@command{grub-mkimage} and installs it on your system.  You must specify the
> +device name on which you want to install GRUB, like this:
>  
>  @example
>  grub-install @var{install_device}
> 
> === modified file 'docs/man/grub-bios-setup.h2m'
> --- docs/man/grub-bios-setup.h2m	2012-02-27 13:24:22 +0000
> +++ docs/man/grub-bios-setup.h2m	2013-01-02 17:07:57 +0000
> @@ -1,5 +1,5 @@
>  [NAME]
> -grub-setup \- set up a device to boot using GRUB
> +grub-bios-setup \- set up a device to boot using GRUB
>  [SEE ALSO]
>  .BR grub-install (8),
>  .BR grub-mkimage (1),
> 
> === modified file 'docs/man/grub-install.h2m'
> --- docs/man/grub-install.h2m	2011-04-21 14:17:48 +0000
> +++ docs/man/grub-install.h2m	2013-01-07 10:49:45 +0000
> @@ -3,5 +3,4 @@ grub-install \- install GRUB to a device
>  [SEE ALSO]
>  .BR grub-mkconfig (8),
>  .BR grub-mkimage (1),
> -.BR grub-setup (8),
>  .BR grub-mkrescue (1)
> 
> === modified file 'docs/man/grub-mkimage.h2m'
> --- docs/man/grub-mkimage.h2m	2011-04-21 14:17:48 +0000
> +++ docs/man/grub-mkimage.h2m	2013-01-07 10:49:54 +0000
> @@ -2,6 +2,5 @@
>  grub-mkimage \- make a bootable image of GRUB
>  [SEE ALSO]
>  .BR grub-install (8),
> -.BR grub-setup (8),
>  .BR grub-mkrescue (1),
>  .BR grub-mknetdir (8)
> 
> === modified file 'docs/man/grub-sparc64-setup.h2m'
> --- docs/man/grub-sparc64-setup.h2m	2012-02-27 13:24:22 +0000
> +++ docs/man/grub-sparc64-setup.h2m	2013-01-02 17:08:02 +0000
> @@ -1,5 +1,5 @@
>  [NAME]
> -grub-setup \- set up a device to boot using GRUB
> +grub-sparc64-setup \- set up a device to boot using GRUB
>  [SEE ALSO]
>  .BR grub-install (8),
>  .BR grub-mkimage (1),
> 
> === modified file 'util/bash-completion.d/grub-completion.bash.in'
> --- util/bash-completion.d/grub-completion.bash.in	2012-12-28 06:57:17 +0000
> +++ util/bash-completion.d/grub-completion.bash.in	2013-01-02 17:09:52 +0000
> @@ -252,10 +252,16 @@ _grub_setup () {
>          _filedir
>      fi
>  }
> -__grub_setup_program="@grub_setup@"
> -have ${__grub_setup_program} && \
> - complete -F _grub_setup -o filenames ${__grub_setup_program}
> -unset __grub_setup_program
> +
> +__grub_bios_setup_program="@grub_bios_setup@"
> +have ${__grub_bios_setup_program} && \
> + complete -F _grub_setup -o filenames ${__grub_bios_setup_program}
> +unset __grub_bios_setup_program
> +
> +__grub_sparc64_setup_program="@grub_sparc64_setup@"
> +have ${__grub_sparc64_setup_program} && \
> + complete -F _grub_setup -o filenames ${__grub_sparc64_setup_program}
> +unset __grub_sparc64_setup_program
>  
>  
>  #
> 
> === modified file 'util/grub-install.in'
> --- util/grub-install.in	2012-12-28 06:57:17 +0000
> +++ util/grub-install.in	2013-01-07 10:49:33 +0000
> @@ -114,8 +114,8 @@ echo
>  gettext "INSTALL_DEVICE must be system device filename.";echo
>  echo
>  
> -gettext_printf "%s copies GRUB images into %s, and uses grub-setup
> -to install grub into the boot sector.\n" "$self" "$grubdir";echo
> +gettext_printf "%s copies GRUB images into %s.  On some platforms, it
> +may also install GRUB into the boot sector.\n" "$self" "$grubdir";echo
>  echo
>  gettext "Report bugs to <bug-grub@gnu.org>."; echo
>  }
> 
> 



-- 
Regards
Vladimir 'φ-coder/phcoder' Serbinenko


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 294 bytes --]