Documentation for (Re: Obtaining the MAC address of the boot NIC for a PXE boot)

[Andrey Borzenkov]

В Tue, 07 May 2013 12:03:51 +0200
Vladimir 'φ-coder/phcoder' Serbinenko <address@hidden> пишет:

> Fixed this and another problem with it, tested and now comitting.
> 

Below documentation for new variables. It also changes variables
description to indicate that they contain variable interface name (do
we need to list possible values?). OK to commit?

From: Andrey Borzenkov <address@hidden>
To: address@hidden
Subject: [PATCH] document new net_default_(interface|ip|mac) variables

Also generalize description to indicate that other variables may apply
to more than pxe interface.

Signed-off-by: Andrey Borzenkov <address@hidden>

---
 docs/grub.texi | 111 +++++++++++++++++++++++++++++++++++++++------------------
 1 file changed, 76 insertions(+), 35 deletions(-)

diff --git a/docs/grub.texi b/docs/grub.texi
index bfd42ee..79bbcb0 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -2134,36 +2134,49 @@ this should be changed both in the prefix and in any 
references to the
 device name in the configuration file.
 
 GRUB provides several environment variables which may be used to inspect or
-change the behaviour of the PXE device:
+change the behaviour of the PXE device. In the following description
address@hidden<interface>} is placeholder for the name of network interface 
(platform
+dependent):
 
 @table @samp
address@hidden net_pxe_ip
-The IP address of this machine.  Read-only.
address@hidden address@hidden<interface>}_ip
+The network interface's IP address.  Read-only.
 
address@hidden net_pxe_mac
address@hidden address@hidden<interface>}_mac
 The network interface's MAC address.  Read-only.
 
address@hidden net_pxe_hostname
address@hidden address@hidden<interface>}_hostname
 The client host name provided by DHCP.  Read-only.
 
address@hidden net_pxe_domain
address@hidden address@hidden<interface>}_domain
 The client domain name provided by DHCP.  Read-only.
 
address@hidden net_pxe_rootpath
address@hidden address@hidden<interface>}_rootpath
 The path to the client's root disk provided by DHCP.  Read-only.
 
address@hidden net_pxe_extensionspath
address@hidden address@hidden<interface>}_extensionspath
 The path to additional DHCP vendor extensions provided by DHCP.  Read-only.
 
address@hidden net_pxe_boot_file
address@hidden address@hidden<interface>}_boot_file
 The boot file name provided by DHCP.  Read-only.
 
address@hidden net_pxe_dhcp_server_name
address@hidden address@hidden<interface>}_dhcp_server_name
 The name of the DHCP server responsible for these boot parameters.
 Read-only.
 
address@hidden net_default_interface
+The name of interface that was used to load grub.  Read-only.
+
address@hidden net_default_ip
+The IP address of default interface. Read-only. This is alias for the
address@hidden@address@hidden
+
address@hidden net_default_mac
+The default interface's MAC address.  Read-only.  This is alias for the
address@hidden@address@hidden
+
 @item net_default_server
-The default server.  Read-write, although setting this is only useful
+The default TFTP server.  Read-write, although setting this is only useful
 before opening a network device.
 
 @end table
@@ -2735,14 +2748,18 @@ These variables have special meaning to GRUB.
 * locale_dir::
 * menu_color_highlight::
 * menu_color_normal::
-* net_pxe_boot_file::
-* net_pxe_dhcp_server_name::
-* net_pxe_domain::
-* net_pxe_extensionspath::
-* net_pxe_hostname::
-* net_pxe_ip::
-* net_pxe_mac::
-* net_pxe_rootpath::
+* address@hidden<interface>}_boot_file::
+* address@hidden<interface>}_dhcp_server_name::
+* address@hidden<interface>}_domain::
+* address@hidden<interface>}_extensionspath::
+* address@hidden<interface>}_hostname::
+* address@hidden<interface>}_ip::
+* address@hidden<interface>}_mac::
+* address@hidden<interface>}_rootpath::
+* net_default_interface::
+* net_default_ip::
+* net_default_mac::
+* net_default_server::
 * pager::
 * prefix::
 * pxe_blksize::
@@ -3009,50 +3026,74 @@ variable changes those colors.  For the available color 
names,
 The default is the value of @samp{color_normal} (@pxref{color_normal}).
 
 
address@hidden net_pxe_boot_file
address@hidden net_pxe_boot_file
address@hidden address@hidden<interface>}_boot_file
address@hidden address@hidden<interface>}_boot_file
+
address@hidden
+
+
address@hidden address@hidden<interface>}_dhcp_server_name
address@hidden address@hidden<interface>}_dhcp_server_name
+
address@hidden
+
+
address@hidden address@hidden<interface>}_domain
address@hidden address@hidden<interface>}_domain
+
address@hidden
+
+
address@hidden address@hidden<interface>}_extensionspath
address@hidden address@hidden<interface>}_extensionspath
+
address@hidden
+
+
address@hidden address@hidden<interface>}_hostname
address@hidden address@hidden<interface>}_hostname
 
 @xref{Network}.
 
 
address@hidden net_pxe_dhcp_server_name
address@hidden net_pxe_dhcp_server_name
address@hidden address@hidden<interface>}_ip
address@hidden address@hidden<interface>}_ip
 
 @xref{Network}.
 
 
address@hidden net_pxe_domain
address@hidden net_pxe_domain
address@hidden address@hidden<interface>}_mac
address@hidden address@hidden<interface>}_mac
 
 @xref{Network}.
 
 
address@hidden net_pxe_extensionspath
address@hidden net_pxe_extensionspath
address@hidden address@hidden<interface>}_rootpath
address@hidden address@hidden<interface>}_rootpath
 
 @xref{Network}.
 
 
address@hidden net_pxe_hostname
address@hidden net_pxe_hostname
address@hidden net_default_interface
address@hidden net_default_interface
 
 @xref{Network}.
 
 
address@hidden net_pxe_ip
address@hidden net_pxe_ip
address@hidden net_default_ip
address@hidden net_default_ip
 
 @xref{Network}.
 
 
address@hidden net_pxe_mac
address@hidden net_pxe_mac
address@hidden net_default_mac
address@hidden net_default_mac
 
 @xref{Network}.
 
 
address@hidden net_pxe_rootpath
address@hidden net_pxe_rootpath
address@hidden net_default_server
address@hidden net_default_server
 
 @xref{Network}.
 
-- 
tg: (48f959f..) u/default_interface (depends on: master)

signature.asc
Description: PGP signature