Several GRUB documentation improvements
cover Several GRUB documentation improvements
1. Several minor documentation improvements.
2. Document new libgcrypt modules.
3. Correct / update several URLs in the documentation.
Andrew Hamilton (4):
docs: Clarify Section Heading and Fix Wording
docs: Document New libgrypt Modules
docs: Update Future Section to Reflect Current Release
docs: Correct Some URLs
docs/grub.texi | 93 ++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 82 insertions(+), 11 deletions(-)
Signature · 7 lines
2.39.5 _______________________________________________ Grub-devel mailing list [email protected] https://lists.gnu.org/mailman/listinfo/grub-devel
PATCH 1/4 docs: Clarify Section Heading and Fix Wording
Update chapter name from "Outline" to "Platform-specific operations" to improve readability. Also slightly improve some wording in this section.
--- docs/grub.texi | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
docs/grub.texi +3 -3
@@ -9519,10 +9519,10 @@ to install to is specified, UUID is used instead as well. @end multitable @node Platform-specific operations -@chapter Outline +@chapter Platform-specific operations -Some platforms have features which allows to implement -some commands useless or not implementable on others. +Some platforms have features which allow implementation of +certain commands that cannot be implemented on others. Quick summary:
Signature · 7 lines
2.39.5 _______________________________________________ Grub-devel mailing list [email protected] https://lists.gnu.org/mailman/listinfo/grub-devel
PATCH 2/4 docs: Document New libgrypt Modules
In reply to Andrew HamiltonAdd documentation for new libgcrypt modules imported into GRUB.
--- docs/grub.texi | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+)
docs/grub.texi +71 -0
@@ -3935,6 +3935,7 @@ Modules can be loaded via the @command{insmod} (@pxref{insmod}) command. * div_test_module:: * dm_nv_module:: * drivemap_module:: +* dsa_sexp_test_module:: * echo_module:: * efi_gop_module:: * efi_uga_module::
@@ -3963,24 +3964,33 @@ Modules can be loaded via the @command{insmod} (@pxref{insmod}) command. * fshelp_module:: * functional_test_module:: * gcry_arcfour_module:: +* gcry_aria_module:: +* gcry_blake2_module:: * gcry_blowfish_module:: * gcry_camellia_module:: * gcry_cast5_module:: * gcry_crc_module:: * gcry_des_module:: * gcry_dsa_module:: +* gcry_gost28147_module:: +* gcry_gostr3411_94_module:: * gcry_idea_module:: +* gcry_keccak_module:: * gcry_md4_module:: * gcry_md5_module:: * gcry_rfc2268_module:: * gcry_rijndael_module:: * gcry_rmd160_module:: * gcry_rsa_module:: +* gcry_salsa20_module:: * gcry_seed_module:: * gcry_serpent_module:: * gcry_sha1_module:: * gcry_sha256_module:: * gcry_sha512_module:: +* gcry_sm3_module:: +* gcry_sm4_module:: +* gcry_stribog_module:: * gcry_tiger_module:: * gcry_twofish_module:: * gcry_whirlpool_module::
@@ -4099,6 +4109,7 @@ Modules can be loaded via the @command{insmod} (@pxref{insmod}) command. * probe_module:: * procfs_module:: * progress_module:: +* pubkey_module:: * pxe_module:: * pxechain_module:: * raid5rec_module::
@@ -4111,6 +4122,7 @@ Modules can be loaded via the @command{insmod} (@pxref{insmod}) command. * reiserfs_module:: * relocator_module:: * romfs_module:: +* rsa_sexp_test_module:: * scsi_module:: * sdl_module:: * search_module::
@@ -4496,6 +4508,10 @@ This module provides support for handling some Nvidia "fakeraid" disk devices. This module provides support for the @command{drivemap} to manage BIOS drive mappings. @xref{drivemap} for more information. +@node dsa_sexp_test_module +@section dsa_sexp_test +This module provides a test of the libgcrypt DSA functionality in GRUB. + @node echo_module @section echo This module provides support for the @command{echo} to display a line of text.
@@ -4633,6 +4649,11 @@ This module provides support functions (helper functions) for file systems. This module provides support for running the GRUB functional tests using commands @command{functional_test} and @command{all_functional_test}. +@node gcry_aria_module +@section gcry_aria +This module provides support for the ARIA cipher. +This GRUB module is based on libgcrypt. + @node gcry_arcfour_module @section gcry_arcfour This module provides support for the arcfour stream cipher also known as RC4.
@@ -4640,6 +4661,11 @@ If security is a concern, RC4 / arcfour cipher is consider broken (multiple known vulnerabilities make this insecure). This GRUB module is based on libgcrypt. +@node gcry_blake2_module +@section gcry_blake2 +This module provides support for the BLAKE2b and BLAKE2s message digests. +This GRUB module is based on libgcrypt. + @node gcry_blowfish_module @section gcry_blowfish This module provides support for the Blowfish cipher.
@@ -4674,12 +4700,28 @@ This GRUB module is based on libgcrypt. This module provides support for the Digital Signature Algorithm (DSA) cipher. This GRUB module is based on libgcrypt. +@node gcry_gost28147_module +@section gcry_gost28147 +This module provides support for the GOST 28147-89 cipher. +This GRUB module is based on libgcrypt. + +@node gcry_gostr3411_94_module +@section gcry_gostr3411_94 +This module provides support for the GOST R 34.11-94 message digest. +This GRUB module is based on libgcrypt. + @node gcry_idea_module @section gcry_idea This module provides support for the International Data Encryption Algorithm (IDEA) cipher. This GRUB module is based on libgcrypt. +@node gcry_keccak_module +@section gcry_keccak +This module provides support for the SHA3 hash message digests (including +SHAKE128 and SHAKE256). +This GRUB module is based on libgcrypt. + @node gcry_md4_module @section gcry_md4 This module provides support for the Message Digest 4 (MD4) message digest.
@@ -4714,6 +4756,11 @@ This GRUB module is based on libgcrypt. This module provides support for the Rivest–Shamir–Adleman (RSA) cipher. This GRUB module is based on libgcrypt. +@node gcry_salsa20_module +@section gcry_salsa20 +This module provides support for the Salsa20 cipher. +This GRUB module is based on libgcrypt. + @node gcry_seed_module @section gcry_seed This module provides support for the SEED cipher.
@@ -4744,6 +4791,21 @@ This module provides support for the Secure Hash Algorithm 2 (384 and 512 bit) (SHA-384 / SHA-512) message digests. This GRUB module is based on libgcrypt. +@node gcry_sm3_module +@section gcry_sm3 +This module provides support for the SM3 message digest. +This GRUB module is based on libgcrypt. + +@node gcry_sm4_module +@section gcry_sm4 +This module provides support for the SM4 cipher. +This GRUB module is based on libgcrypt. + +@node gcry_stribog_module +@section gcry_stribog +This module provides support for the GOST R 34.11-2012 (Stribog) message digest. +This GRUB module is based on libgcrypt. + @node gcry_tiger_module @section gcry_tiger This module provides support for the Tiger, Tiger 1, and Tiger 2 message
@@ -5509,6 +5571,11 @@ like interface to some GRUB internal data. @section progress This module provides support for showing file loading progress to the terminal. +@node pubkey_module +@section pubkey +This module provides supporting functions for using RSA and DSA public keys. +This GRUB module is based on libgcrypt. + @node pxe_module @section pxe This module provides support for Preboot Execution Environment (PXE) network
@@ -5571,6 +5638,10 @@ This module provides support for the Read-Only Memory File System (ROMFS). Note: This module is not allowed in lockdown mode, @pxref{Lockdown} for more information. +@node rsa_sexp_test_module +@section rsa_sexp_test +This module provides a test of the libgcrypt RSA functionality in GRUB. + @node scsi_module @section scsi This module provides support for the Small Computer System Interface (SCSI)
Signature · 7 lines
2.39.5 _______________________________________________ Grub-devel mailing list [email protected] https://lists.gnu.org/mailman/listinfo/grub-devel
PATCH 3/4 docs: Update Future Section to Reflect Current Release
In reply to Andrew HamiltonUpdate the Future section of the GRUB manual to reflect current work on the 2.x series.
--- docs/grub.texi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
docs/grub.texi +1 -1
@@ -10632,7 +10632,7 @@ Once we get your report, we will try to fix the bugs. @appendix Where GRUB will go GRUB 2 is now quite stable and used in many production systems. We are -currently working towards a 2.0 release. +currently working on the 2.x series. If you are interested in the development of GRUB 2, take a look at @uref{http://www.gnu.org/software/grub/grub.html, the homepage}.
Signature · 7 lines
2.39.5 _______________________________________________ Grub-devel mailing list [email protected] https://lists.gnu.org/mailman/listinfo/grub-devel
PATCH 4/4 docs: Correct Some URLs
In reply to Andrew HamiltonCorrect some outdated links to various websites and change http to https in a few places.
--- docs/grub.texi | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
docs/grub.texi +7 -7
@@ -10527,16 +10527,16 @@ Print each line of input after reading it. @strong{Caution:} GRUB requires binutils-2.9.1.0.23 or later because the GNU assembler has been changed so that it can produce real 16bits machine code between 2.9.1 and 2.9.1.0.x. See -@uref{http://sources.redhat.com/binutils/}, to obtain information on +@uref{https://www.gnu.org/software/binutils/}, to obtain information on how to get the latest version. @end quotation GRUB is available from the GNU alpha archive site -@uref{ftp://ftp.gnu.org/gnu/grub} or any of its mirrors. The file +@uref{https://ftp.gnu.org/gnu/grub/} or any of its mirrors. The file will be named grub-version.tar.gz. The current version is @value{VERSION}, so the file you should grab is: -@uref{ftp://ftp.gnu.org/gnu/grub/grub-@value{VERSION}.tar.gz} +@uref{https://ftp.gnu.org/gnu/grub/grub-@value{VERSION}.tar.gz} To unbundle GRUB use the instruction:
@@ -10558,7 +10558,7 @@ just do: @end example Also, the latest version is available using Git. See -@uref{http://www.gnu.org/software/grub/grub-download.html} for more +@uref{https://www.gnu.org/software/grub/grub-download.html} for more information. @node Reporting bugs
@@ -10570,7 +10570,7 @@ list below before you submit bugs: @enumerate @item Before getting unsettled, read this manual through and through. Also, -see the @uref{http://www.gnu.org/software/grub/grub-faq.html, GNU GRUB FAQ}. +see the @uref{https://www.gnu.org/software/grub/grub-faq.html, GNU GRUB FAQ}. @item Always mention the information on your GRUB. The version number and the
@@ -10620,7 +10620,7 @@ important. @end enumerate If you follow the guideline above, submit a report to the -@uref{http://savannah.gnu.org/bugs/?group=grub, Bug Tracking System}. +@uref{https://savannah.gnu.org/bugs/?group=grub, Bug Tracking System}. Alternatively, you can submit a report via electronic mail to @email{bug-grub@@gnu.org}, but we strongly recommend that you use the Bug Tracking System, because e-mail can be passed over easily.
@@ -10635,7 +10635,7 @@ GRUB 2 is now quite stable and used in many production systems. We are currently working on the 2.x series. If you are interested in the development of GRUB 2, take a look at -@uref{http://www.gnu.org/software/grub/grub.html, the homepage}. +@uref{https://www.gnu.org/software/grub/grub.html, the homepage}.
Signature · 7 lines
2.39.5 _______________________________________________ Grub-devel mailing list [email protected] https://lists.gnu.org/mailman/listinfo/grub-devel
Quoted 9 lines · Andrew Hamilton
1. Several minor documentation improvements.
2. Document new libgcrypt modules.
3. Correct / update several URLs in the documentation.Andrew Hamilton (4):
docs: Clarify Section Heading and Fix Wording
docs: Document New libgrypt Modules
docs: Update Future Section to Reflect Current Release
docs: Correct Some URLs
For all patches Reviewed-by: Daniel Kiper <[email protected]>...
Daniel
_______________________________________________
Grub-devel mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/grub-devel