[PATCH v3 0/3] docs: Small Fixes for Network, Secure Boot, PXE

[PATCH v3 0/3] docs: Small Fixes for Network, Secure Boot, PXE

[Andrew Hamilton]

Currently the GRUB Manual has a few small issues captured in bug
reports (54480, 62004, and 65152). These are related to issues in
documentation for environment variables "pxe_default_server",
"pxe_default_gateway"; incorrect statement that "chainloader" does
not support secure boot; and an issue in network boot documentation
for the searched grub.cfg name.

These issues have been updated in the grub manual, grub.texi.

From user perspective, this patch improves /  corrects / clarifies
documentation around PXE, Secure Boot, and Network booting.

Changes in v3:
	- Split patches by bug report fixed.
	- Corrected "Closes" to "Fixes" in commits.
Changes in v2:
	- Regenerate patch against current master branch.

Andrew Hamilton (3):
  Correct documentation for pxe_default_server, pxe_default_gatway, and
    pxe_blksize. Only pxe_default_server is actually used (alias for
    net_default_server) so capture this, and remove the other two.
  Correct documentation for secure boot with UEFI to remove statement
    that chainloader does not work with secure boot, as this was added
    by a previous GRUB update.
  Correct the documentation for the grub.cfg searching via network that
    will be done based on a given MAC address (was missing the Ethernet
    Type - 01).

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

-- 
2.39.5


_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel

[PATCH v3 1/3] docs: Small Fixes for Network, Secure Boot, PXE

[Andrew Hamilton]

Correct documentation for pxe_default_server, pxe_default_gatway, and
pxe_blksize. Only pxe_default_server is actually used (alias for 
net_default_server) so capture this, and remove the other two.

Fixes: https://savannah.gnu.org/bugs/?54480

Signed-off-by: Andrew Hamilton <adhamilt@gmail.com>
---
 docs/grub.texi | 17 +++--------------
 1 file changed, 3 insertions(+), 14 deletions(-)

diff --git a/docs/grub.texi b/docs/grub.texi
index 2ea6c56d1..62dace828 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -2680,6 +2680,9 @@ The default interface's MAC address.  Read-only.  This is alias for the
 The default server used by network drives (@pxref{Device syntax}).  Read-write,
 although setting this is only useful before opening a network device.
 
+@item pxe_default_server
+This performs the same function as @samp{net_default_server}.
+
 @end table
 
 
@@ -3310,8 +3313,6 @@ These variables have special meaning to GRUB.
 * net_default_server::
 * pager::
 * prefix::
-* pxe_blksize::
-* pxe_default_gateway::
 * pxe_default_server::
 * root::
 * shim_lock::
@@ -3755,18 +3756,6 @@ dynamically loaded from this directory, so it must be set correctly in order
 for many parts of GRUB to work.
 
 
-@node pxe_blksize
-@subsection pxe_blksize
-
-@xref{Network}.
-
-
-@node pxe_default_gateway
-@subsection pxe_default_gateway
-
-@xref{Network}.
-
-
 @node pxe_default_server
 @subsection pxe_default_server
 
-- 
2.39.5


_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel

[PATCH v3 2/3] docs: Small Fixes for Network, Secure Boot, PXE

[Andrew Hamilton]

Correct documentation for secure boot with UEFI to remove statement that
chainloader does not work with secure boot, as this was added by a
previous GRUB update.

Fixes: https://savannah.gnu.org/bugs/?62004

Signed-off-by: Andrew Hamilton <adhamilt@gmail.com>
---
 docs/grub.texi | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/docs/grub.texi b/docs/grub.texi
index 62dace828..5dd4ed84f 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -8678,13 +8678,13 @@ secure boot chain.
 @node UEFI secure boot and shim
 @section UEFI secure boot and shim support
 
-The GRUB, except the @command{chainloader} command, works with the UEFI secure
-boot and the shim. This functionality is provided by the shim_lock verifier. It
-is built into the @file{core.img} and is registered if the UEFI secure boot is
-enabled. The @samp{shim_lock} variable is set to @samp{y} when shim_lock verifier
-is registered. If it is desired to use UEFI secure boot without shim, one can
-disable shim_lock by disabling shim verification with MokSbState UEFI variable
-or by building grub image with @samp{--disable-shim-lock} option.
+The GRUB works with UEFI secure boot and the shim. This functionality is
+provided by the shim_lock verifier. It is built into the @file{core.img} and is
+registered if the UEFI secure boot is enabled. The @samp{shim_lock} variable is
+set to @samp{y} when shim_lock verifier is registered. If it is desired to use
+UEFI secure boot without shim, one can disable shim_lock by disabling shim
+verification with MokSbState UEFI variable or by building grub image with
+@samp{--disable-shim-lock} option.
 
 All GRUB modules not stored in the @file{core.img}, OS kernels, ACPI tables,
 Device Trees, etc. have to be signed, e.g, using PGP. Additionally, the commands
-- 
2.39.5


_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel

[PATCH v3 3/3] docs: Small Fixes for Network, Secure Boot, PXE

[Andrew Hamilton]

Correct the documentation for the grub.cfg searching via network that
will be done based on a given MAC address (was missing the Ethernet
Type - 01).

Fixes: https://savannah.gnu.org/bugs/?65152

Signed-off-by: Andrew Hamilton <adhamilt@gmail.com>
---
 docs/grub.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/grub.texi b/docs/grub.texi
index 5dd4ed84f..78d47f467 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -2571,7 +2571,7 @@ value corresponds to a value on the client machine.
 @example
 @group
 @samp{(FWPATH)}/grub.cfg-@samp{(UUID OF MACHINE)}
-@samp{(FWPATH)}/grub.cfg-@samp{(MAC ADDRESS OF NIC)}
+@samp{(FWPATH)}/grub.cfg-01-@samp{(MAC ADDRESS OF NIC)}
 @samp{(FWPATH)}/grub.cfg-@samp{(IPv4 OR IPv6 ADDRESS)}
 @samp{(FWPATH)}/grub.cfg
 @end group
@@ -2596,7 +2596,7 @@ IPV4: 10.0.0.130 (0A000082)
 @example
 @group
 @samp{(FWPATH)}/grub.cfg-7726a678-7fc0-4853-a4f6-c85ac36a120a
-@samp{(FWPATH)}/grub.cfg-52-54-00-ec-33-81
+@samp{(FWPATH)}/grub.cfg-01-52-54-00-ec-33-81
 @samp{(FWPATH)}/grub.cfg-0A000082
 @samp{(FWPATH)}/grub.cfg-0A00008
 @samp{(FWPATH)}/grub.cfg-0A0000
-- 
2.39.5


_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel

Re: [PATCH v3 0/3] docs: Small Fixes for Network, Secure Boot, PXE

[Daniel Kiper]

On Thu, Oct 24, 2024 at 08:37:51PM -0500, Andrew Hamilton wrote:
> Currently the GRUB Manual has a few small issues captured in bug
> reports (54480, 62004, and 65152). These are related to issues in
> documentation for environment variables "pxe_default_server",
> "pxe_default_gateway"; incorrect statement that "chainloader" does
> not support secure boot; and an issue in network boot documentation
> for the searched grub.cfg name.
>
> These issues have been updated in the grub manual, grub.texi.
>
> From user perspective, this patch improves /  corrects / clarifies
> documentation around PXE, Secure Boot, and Network booting.
>
> Changes in v3:
> 	- Split patches by bug report fixed.
> 	- Corrected "Closes" to "Fixes" in commits.
> Changes in v2:
> 	- Regenerate patch against current master branch.

A patch title should reflect what the patch do. It should not be a copy
of cover letter. If you fix that for every patch you can add
"Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>" to all of them.

Daniel

_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel