documentation: Clarify documentation for special environment variable "default".
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Fri, 3 Feb 2017 11:32:25 +0000 (12:32 +0100)
committerVladimir Serbinenko <phcoder@gmail.com>
Fri, 3 Feb 2017 11:32:25 +0000 (12:32 +0100)
commitbf94ef7fbdc22e24c3da63f63a1eb6975bab2b40
treefe5c127025da24722d25ad2d608f60eaeba84fe6
parent5412028d19915311c0b44bdd6a3e46bbc343c373
documentation: Clarify documentation for special environment variable "default".

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

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, or any indication about
whether counting is zero-indexed or 1-indexed.

Having a cleaner example and presenting all variants (numeric, title,
and id) should make it clearer to the user.

Signed-off-by: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
docs/grub.texi