[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH] Clarify documentation for special environment variable "default"

From: Daniel Kahn Gillmor
Subject: [PATCH] Clarify documentation for special environment variable "default"
Date: Thu, 2 Feb 2017 19:19:40 -0500

The current documentation for the special environment variable
"default" is confusing and unclear.  This patch attempts to clean it

In particular, the current documentation refers to the "number or
title", but then in the example it gives, the menu entries and
submenus all have numbers *in* their title; furthermore, there is no
example given about how to choose the number (e.g. does it start at 1
or at 0?).

Having a cleaner example and presenting both the numeric version and
the title version will make it clearer.

In my patch here i've tried to make it clear and understandable.  I've
also assumed that the number counting starts at 1, but haven't
verified that.  If that's wrong, please commit the corrected version

Signed-off-by: Daniel Kahn Gillmor <address@hidden>
 docs/grub.texi | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/docs/grub.texi b/docs/grub.texi
index b9ddb9b8a..e868f045d 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -3242,18 +3242,18 @@ title of the menu entry itself, separated by @samp{>}.  
For example, take
 the following menu structure:
-Submenu 1
-  Menu Entry 1
-  Menu Entry 2
-Submenu 2
-  Submenu 3
-    Menu Entry 3
-    Menu Entry 4
-  Menu Entry 5
+  Standard Boot
+  Rescue shell
+Other platforms
+  Minix
+    Version 3.4.0
+    Version 3.3.0
+  GRUB Invaders
 @end example
-``Menu Entry 3'' would then be identified as
address@hidden 2>Submenu 3>Menu Entry 3}.
+The more recent release of Minix would then be identified as
address@hidden platforms>Minix>Version 3.4.0}, or as @samp{2>1>1}.
 This variable is often set by @samp{GRUB_DEFAULT} (@pxref{Simple
 configuration}), @command{grub-set-default}, or @command{grub-reboot}.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]