From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.71) id 1Tt2hs-0002r0-5D for mharc-grub-devel@gnu.org; Wed, 09 Jan 2013 15:57:04 -0500 Received: from eggs.gnu.org ([208.118.235.92]:52917) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tt2hn-0002oV-Vw for grub-devel@gnu.org; Wed, 09 Jan 2013 15:57:02 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Tt2hl-0004q3-Vo for grub-devel@gnu.org; Wed, 09 Jan 2013 15:56:59 -0500 Received: from mail-we0-f172.google.com ([74.125.82.172]:35564) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Tt2hl-0004pt-ML for grub-devel@gnu.org; Wed, 09 Jan 2013 15:56:57 -0500 Received: by mail-we0-f172.google.com with SMTP id r3so1267867wey.31 for ; Wed, 09 Jan 2013 12:56:55 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=x-received:message-id:date:from:user-agent:mime-version:to:subject :references:in-reply-to:x-enigmail-version:content-type; bh=5C+z2XMSWtAQL+hcnaG9ER/G0vtKDq2gbfeDNDsS0/s=; b=GcIcs+9/ovz3mV0srdC0h0O9Olhe6pJH9eTH06kPYa36E9lD0+jVjUpKTmHh1wVsIu 9A86d+2UkH3HU3AjUaHSRcoLqb6CKxH/0UjqYg8aNRGqJAx2rMsmav3ZX75s/6lERXof HXUv7x3QT0nJlSwkHxgmUD7nguw/BoH7d24oOkaUHNdzS+LrsXS1909sXL+wXjGEu6Lb Z+3Al7AYXfgWQHbu2mHmuPgzwDVcnhdk15LMs89tAg0asC7pP7N4wzVg9ZWlhaxGk5Xv fCNIom1CtLROEqF4ECW+8ImKZTbaSUu6RvKDZrxEgAFdyubJubTtcSJbk7h3BnW3zIVh JtWg== X-Received: by 10.180.95.169 with SMTP id dl9mr5417953wib.20.1357765015048; Wed, 09 Jan 2013 12:56:55 -0800 (PST) Received: from debian.x201.phnet ([217.193.148.98]) by mx.google.com with ESMTPS id bw9sm5515754wib.5.2013.01.09.12.56.53 (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Wed, 09 Jan 2013 12:56:54 -0800 (PST) Message-ID: <50EDD990.8010903@gmail.com> Date: Wed, 09 Jan 2013 21:56:48 +0100 From: =?UTF-8?B?VmxhZGltaXIgJ8+GLWNvZGVyL3BoY29kZXInIFNlcmJpbmVua28=?= User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:10.0.11) Gecko/20121122 Icedove/10.0.11 MIME-Version: 1.0 To: grub-devel@gnu.org Subject: Re: [PATCH] Clean up dangling references to grub-setup References: <20130102171852.GC21216@riva.dynamic.greenend.org.uk> <50E5BC27.5090209@gmail.com> <20130107105404.GC26167@riva.dynamic.greenend.org.uk> In-Reply-To: <20130107105404.GC26167@riva.dynamic.greenend.org.uk> X-Enigmail-Version: 1.4.1 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="------------enig69DE9A378BB83ED7A6023417" X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [fuzzy] X-Received-From: 74.125.82.172 X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list Reply-To: The development of GNU GRUB List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 09 Jan 2013 20:57:02 -0000 This is an OpenPGP/MIME signed message (RFC 2440 and 3156) --------------enig69DE9A378BB83ED7A6023417 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable On 07.01.2013 11:54, Colin Watson wrote: > On Thu, Jan 03, 2013 at 06:13:11PM +0100, Vladimir '=CF=86-coder/phcode= r' 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. >=20 > OK. How about this? Good. Go ahead. >=20 > 2013-01-07 Colin Watson >=20 > * 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. >=20 > * 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. >=20 > * 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. >=20 > =3D=3D=3D 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]) > =20 > # Optimization flag. Allow user to override. >=20 > =3D=3D=3D 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. > =20 > Note that @command{grub-install} is actually just a shell script and t= he > -real task is done by @command{grub-mkimage} and @command{grub-setup}. > -Therefore, you may run those commands directly to install GRUB, withou= t > -using @command{grub-install}. Don't do that, however, unless you are v= ery > -familiar with the internals of GRUB. Installing a boot loader on a run= ning > -OS may be extremely dangerous. > +real task is done by other tools such as @command{grub-mkimage}. There= fore, > +you may run those commands directly to install GRUB, without using > +@command{grub-install}. Don't do that, however, unless you are very fa= miliar > +with the internals of GRUB. Installing a boot loader on a running OS m= ay be > +extremely dangerous. > =20 > @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 > =20 > 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: > =20 > @example > (@var{device}) @var{file} > @@ -2283,8 +2283,8 @@ bytes. > The sole function of @file{boot.img} is to read the first sector of th= e core > image from a local disk and jump to it. Because of the size restricti= on, > @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 t= he > +core image into @file{boot.img} when installing GRUB. > =20 > @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 > =20 > -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 t= his: > +The program @command{grub-install} generates a GRUB core image using > +@command{grub-mkimage} and installs it on your system. You must speci= fy the > +device name on which you want to install GRUB, like this: > =20 > @example > grub-install @var{install_device} >=20 > =3D=3D=3D 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), >=20 > =3D=3D=3D 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) >=20 > =3D=3D=3D 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) >=20 > =3D=3D=3D 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), >=20 > =3D=3D=3D 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=3D"@grub_setup@" > -have ${__grub_setup_program} && \ > - complete -F _grub_setup -o filenames ${__grub_setup_program} > -unset __grub_setup_program > + > +__grub_bios_setup_program=3D"@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=3D"@grub_sparc64_setup@" > +have ${__grub_sparc64_setup_program} && \ > + complete -F _grub_setup -o filenames ${__grub_sparc64_setup_program} > +unset __grub_sparc64_setup_program > =20 > =20 > # >=20 > =3D=3D=3D 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 > =20 > -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 ."; echo > } >=20 >=20 --=20 Regards Vladimir '=CF=86-coder/phcoder' Serbinenko --------------enig69DE9A378BB83ED7A6023417 Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.12 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/ iF4EAREKAAYFAlDt2ZAACgkQNak7dOguQgkgGwD7Bcv2pqu/klwksOF4DhejV0OL yKyQFZvesglpU9fVCXQBAMNaImJKpFr5BShbeTUhbkM5Iwd1Ccu6YdjoCXwTdagZ =LAdp -----END PGP SIGNATURE----- --------------enig69DE9A378BB83ED7A6023417--