Attachment 600060 Details for Bug 212649 – Change for the documentation in the package

[patch] Change for the documentation in the package

grub-0.97-fix-savedefault-docs.patch (text/plain), 7.58 KB, created by Peter Jones on 2012-07-24 15:42:35 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Peter Jones

Created: 2012-07-24 15:42:35 UTC

Size: 7.58 KB

patch

obsolete

>From ea19af7bb7ba7b2993135e0be86bdf6ced735b73 Mon Sep 17 00:00:00 2001
>From: Peter Jones <pjones@redhat.com>
>Date: Tue, 24 Jul 2012 11:40:16 -0400
>Subject: [PATCH] Fix "savedefault" documentation since it's completely wrong.
>
>---
> docs/grub.texi |  107 ++++++++++++++++----------------------------------------
> 1 file changed, 30 insertions(+), 77 deletions(-)
>
>diff --git a/docs/grub.texi b/docs/grub.texi
>index 84ff641..02e4fd4 100644
>--- a/docs/grub.texi
>+++ b/docs/grub.texi
>@@ -27,8 +27,6 @@
> * grub-terminfo: (grub)Invoking grub-terminfo.  Generate a terminfo
>                                                 command from a
>                                                 terminfo name
>-* grub-set-default: (grub)Invoking grub-set-default.    Set a default boot
>-                                                        entry
> * mbchk: (grub)Invoking mbchk.  Check for the format of a Multiboot kernel
> @end direntry
> 
>@@ -118,7 +116,6 @@ This edition documents version @value{VERSION}.
> * Invoking grub-install::       How to use the GRUB installer
> * Invoking grub-md5-crypt::     How to generate a cryptic password
> * Invoking grub-terminfo::      How to generate a terminfo command
>-* Invoking grub-set-default::   How to set a default boot entry
> * Invoking mbchk::              How to use the Multiboot checker
> * Obtaining and Building GRUB:: How to obtain and build GRUB
> * Reporting bugs::              Where you should send a bug report
>@@ -482,7 +479,7 @@ GRUB comes with boot images, which are normally put in the directory
> @file{/usr/lib/grub/i386-pc}. If you do not use grub-install, then
> you need to copy the files @file{stage1}, @file{stage2}, and
> @file{*stage1_5} to the directory @file{/boot/grub}, and run the
>-@command{grub-set-default} (@pxref{Invoking grub-set-default}) if you
>+@command{savedefault} (@pxref{savedefault (shell)}) if you
> intend to use @samp{default saved} (@pxref{default}) in your
> configuration file. Hereafter, the directory where GRUB images are
> initially placed (normally @file{/usr/lib/grub/i386-pc}) will be
>@@ -1155,11 +1152,10 @@ old kernel after it booted the new one, because @samp{0} is the entry
> of @code{the old kernel}.
> 
> The next step is to tell GRUB to boot the new kernel at next boot
>-time. For this, execute @command{grub-set-default} (@pxref{Invoking
>-grub-set-default}):
>+time. For this, execute @command{savedefault} (@pxref{savedefault (shell)}):
> 
> @example
>-# @kbd{grub-set-default 1}
>+# @kbd{savedefault --default=1 --once}
> @end example
> 
> This command sets the saved entry to @samp{1}, that is, to the new
>@@ -1233,14 +1229,14 @@ in starting up your system. So this solution ensures that your system
> is started even if GRUB cannot find your kernel or if your kernel
> panics.
> 
>-However, you need to run @command{grub-set-default} (@pxref{Invoking
>-grub-set-default}) when @samp{A} starts correctly or you fix @samp{A}
>-after it crashes, since GRUB always sets next boot entry to a fallback
>-entry. You should run this command in a startup script such as
>-@file{rc.local} to boot @samp{A} by default:
>+However, you need to run @command{savedefault} (@pxref{savedefault (shell)})
>+when @samp{A} starts correctly or you fix @samp{A} after it crashes, since
>+GRUB always sets next boot entry to a fallback entry. You should run this
>+command in a startup script such as @file{rc.local} to boot @samp{A} by
>+default:
> 
> @example
>-# @kbd{grub-set-default 0}
>+# @kbd{savedefault --once --default=0}
> @end example
> 
> where @samp{0} is the number of the boot entry for the system
>@@ -1252,7 +1248,7 @@ some systems). Because this file is plain-text, you can just
> @command{cat} this file. But it is strongly recommended @strong{not to
> modify this file directly}, because GRUB may fail in saving a default
> entry in this file, if you change this file in an unintended
>-manner. Therefore, you should use @command{grub-set-default} when you
>+manner. Therefore, you should use @command{savedefault} when you
> need to change the default entry.
> 
> 
>@@ -2702,6 +2698,7 @@ you forget a command, you can run the command @command{help}
> * root::                        Set GRUB's root device
> * rootnoverify::                Set GRUB's root device without mounting
> * savedefault::                 Save current entry as the default entry
>+* savedefault (shell)::		Set a new default entry from the grub shell
> * setup::                       Set up GRUB's installation automatically
> * testload::                    Load a file for testing a filesystem
> * testvbe::                     Test VESA BIOS EXTENSION
>@@ -3191,9 +3188,27 @@ You can specify @samp{fallback} instead of a number. Then, next
> fallback entry is saved. Next fallback entry is chosen from fallback
> entries. Normally, this will be the first entry in fallback ones.
> 
>-See also @ref{default} and @ref{Invoking grub-set-default}.
>+See also @ref{default} and @ref{savedefault (shell)}.
> @end deffn
> 
>+@node savedefault (shell)
>+@subsection savedefault (shell)
>+
>+@deffn Command savedefault [@option{--stage2=os_stage2_file}] [@option{--once}] @option{--default=NUM}
>+Set the default boot option.  This version of savedefault is used from the
>+grub shell when invoked from within the operating system.
>+
>+The option @option{--default} specifies which stanza of the configuration file
>+should be set as default.
>+
>+The option @option{--once} specifies that the new default should be used on
>+the next reboot, but should not be used on subsequent boots.
>+
>+@strong{Caution1:} You must specify the option @option{--stage2} in the
>+grub shell, if you cannot unmount the filesystem where your stage2 file
>+resides. The argument should be the file name in your operating system.
>+
>+@end deffn
> 
> @node setup
> @subsection setup
>@@ -3767,68 +3782,6 @@ You must specify one argument to this command. For example:
> @end example
> 
> 
>-@node Invoking grub-set-default
>-@chapter Invoking grub-set-default
>-
>-The program @command{grub-set-default} sets the default boot entry for
>-GRUB. This automatically creates a file named @file{default} under
>-your GRUB directory (i.e. @file{/boot/grub}), if it is not
>-present. This file is used to determine the default boot entry when
>-GRUB boots up your system when you use @samp{default saved} in your
>-configuration file (@pxref{default}), and to save next default boot
>-entry when you use @samp{savedefault} in a boot entry
>-(@pxref{savedefault}).
>-
>-@command{grub-set-default} accepts the following options:
>-
>-@table @option
>-@item --help
>-Print a summary of the command-line options and exit.
>-
>-@item --version
>-Print the version information and exit.
>-
>-@item --root-directory=@var{dir}
>-Use the directory @var{dir} instead of the root directory
>-(i.e. @file{/}) to define the location of the default file. This
>-is useful when you mount a disk which is used for another system.
>-@end table
>-
>-You must specify a single argument to @command{grub-set-default}. This
>-argument is normally the number of a default boot entry. For example,
>-if you have this configuration file:
>-
>-@example
>-@group
>-default saved
>-timeout 10
>-
>-title GNU/Hurd
>-root (hd0,0)
>-...
>-
>-title GNU/Linux
>-root (hd0,1)
>-...
>-@end group
>-@end example
>-
>-and if you want to set the next default boot entry to GNU/Linux, you
>-may execute this command:
>-
>-@example
>-@kbd{grub-set-default 1}
>-@end example
>-
>-Because the entry for GNU/Linux is @samp{1}. Note that entries are
>-counted from zero. So, if you want to specify GNU/Hurd here, then you
>-should specify @samp{0}.
>-
>-This feature is very useful if you want to test a new kernel or to
>-make your system quite robust. @xref{Making your system robust}, for
>-more hints about how to set up a robust system.
>-
>-
> @node Invoking mbchk
> @chapter Invoking mbchk
> 
>-- 
>1.7.10.2
>

Actions: View | Diff

Attachments on bug 212649: 600060