All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] Clean up dangling references to grub-setup
@ 2013-01-02 17:18 Colin Watson
  2013-01-03 17:13 ` Vladimir 'φ-coder/phcoder' Serbinenko
  0 siblings, 1 reply; 6+ messages in thread
From: Colin Watson @ 2013-01-02 17:18 UTC (permalink / raw)
  To: grub-devel

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.

2013-01-02  Colin Watson  <cjwatson@ubuntu.com>

	* docs/grub.texi (Installing GRUB using grub-install): Refer to
	grub-bios-setup and grub-sparc64-setup rather than grub-setup.
	(Device map) Refer to grub-bios-setup rather than grub-setup.
	(Images): Likewise.
	(Invoking grub-install): Refer to grub-bios-setup and
	grub-sparc64-setup rather than grub-setup.
	* 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	2012-12-28 06:57:17 +0000
+++ configure.ac	2013-01-02 17:10:01 +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-02 09:29:48 +0000
+++ docs/grub.texi	2013-01-02 17:06:47 +0000
@@ -616,7 +616,8 @@ 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}.
+real task is done by @command{grub-mkimage} and @command{grub-bios-setup}
+(on i386-pc) or @command{grub-sparc64-setup} (on sparc64-ieee1275).
 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
@@ -682,8 +683,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:
+@command{grub-bios-setup}, etc.) read it to map BIOS drives to OS devices.
+This file consists of lines like this:
 
 @example
 (@var{device}) @var{file}
@@ -2277,8 +2278,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-bios-setup} 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
@@ -4668,8 +4669,9 @@ GRUB.
 @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:
+@command{grub-mkimage} and (on some platforms) @command{grub-bios-setup} or
+@command{grub-sparc64-setup}.  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-02 17:08:22 +0000
@@ -3,5 +3,6 @@ grub-install \- install GRUB to a device
 [SEE ALSO]
 .BR grub-mkconfig (8),
 .BR grub-mkimage (1),
-.BR grub-setup (8),
+.BR grub-bios-setup (8) (on some platforms),
+.BR grub-sparc64-setup (8) (on some platforms),
 .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-02 17:08:14 +0000
@@ -2,6 +2,7 @@
 grub-mkimage \- make a bootable image of GRUB
 [SEE ALSO]
 .BR grub-install (8),
-.BR grub-setup (8),
+.BR grub-bios-setup (8) (on some platforms),
+.BR grub-sparc64-setup (8) (on some platforms),
 .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-02 17:05:30 +0000
@@ -114,7 +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
+gettext_printf "%s copies GRUB images into %s.  Depending on the
+target platform, it may also use grub-bios-setup or grub-sparc64-setup
 to install grub into the boot sector.\n" "$self" "$grubdir";echo
 echo
 gettext "Report bugs to <bug-grub@gnu.org>."; echo

Thanks,

-- 
Colin Watson                                       [cjwatson@ubuntu.com]


^ permalink raw reply	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2013-01-09 20:57 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-01-02 17:18 [PATCH] Clean up dangling references to grub-setup Colin Watson
2013-01-03 17:13 ` Vladimir 'φ-coder/phcoder' Serbinenko
2013-01-07 10:54   ` Colin Watson
2013-01-07 12:01     ` Andrey Borzenkov
2013-01-07 14:43       ` Colin Watson
2013-01-09 20:56     ` Vladimir 'φ-coder/phcoder' Serbinenko

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.