Update documentation with new options '--part-uuid' and '--part-label'
added to 'probe' and 'search' grub-shell commands.
Signed-off-by: Vitaly Kuzmichev <vitaly.kuzmic...@rtsoft.de>
---
docs/grub.texi | 47 +++++++++++++++++++++++++++++++++++------------
1 file changed, 35 insertions(+), 12 deletions(-)
diff --git a/docs/grub.texi b/docs/grub.texi
index be2261670..465fdbd0c 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -1976,7 +1976,11 @@ menuentry "Debian sid installer" @{
Notes:
@itemize
-@item Argument to search after --label is FS LABEL. You can also use UUIDs
with --fs-uuid UUID instead of --label LABEL. You could also use direct
@code{root=hd0,msdosX} but this is not recommended due to device name
instability.
+@item Argument to search after @option{--label} is FS LABEL. You can also
+search by partition label with @option{--part-label LABEL} or use UUIDs
+with @option{--fs-uuid UUID} or @option{--part-uuid UUID} instead of
+@option{--label LABEL}. You could also use direct @code{root=hd0,msdosX}
+but this is not recommended due to device name instability.
@end itemize
@node Embedded configuration
@@ -5365,11 +5369,20 @@ a rest.
@node probe
@subsection probe
-@deffn Command probe [@option{--set} var]
@option{--driver}|@option{--partmap}|@option{--fs}|@option{--fs-uuid}|@option{--label}|@option{--part-uuid}
device
-Retrieve device information. If option @option{--set} is given, assign result
-to variable @var{var}, otherwise print information on the screen.
+@deffn Command probe @
+ [@option{--set} var] @
+ @option{--driver}|@option{--partmap}|@option{--fs}|@option{--label}|@
+@option{--part-label}|@option{--fs-uuid}|@option{--part-uuid} @
+ device
+Retrieve device information. If the (@option{-s}, @option{--set}) option
+is given, assign result to variable @var{var}, otherwise print information
+on the screen.
-The option @option{--part-uuid} is currently only implemented for MSDOS and
GPT formatted disks.
+The (@option{--part-uuid}) option is currently only implemented for MSDOS
+and GPT formatted disks.
+
+The (@option{--part-label}) option is currently only implemented for GPT
+formatted disks, and compares only first 36 characters of partition name.
@end deffn
@@ -5456,11 +5469,14 @@ unbootable. @xref{Using digital signatures}, for more
information.
@subsection search
@deffn Command search @
- [@option{--file}|@option{--label}|@option{--fs-uuid}] @
- [@option{--set} [var]] [@option{--no-floppy}|@option{--efidisk-only}] name
+ [@option{--file}|@option{--label}|@option{--part-label}|@option{--fs-uuid}|@
+@option{--part-uuid}] [@option{--set} [var]] @
+ [@option{--no-floppy}|@option{--efidisk-only}] @
+ name
Search devices by file (@option{-f}, @option{--file}), filesystem label
-(@option{-l}, @option{--label}), or filesystem UUID (@option{-u},
-@option{--fs-uuid}).
+(@option{-l}, @option{--label}), filesystem UUID (@option{-u},
+@option{--fs-uuid}), partition label (@option{--part-label}),
+or partition UUID (@option{-p}, @option{--part-uuid}).
If the (@option{-s}, @option{--set}) option is used, the first device found is
set as the value of environment variable @var{var}. The default variable is
@@ -5472,9 +5488,16 @@ devices, which can be slow.
The (@option{--efidisk-only}) option prevents searching any other devices then
EFI disks. This is typically used when chainloading to local EFI partition.
-The @samp{search.file}, @samp{search.fs_label}, and @samp{search.fs_uuid}
-commands are aliases for @samp{search --file}, @samp{search --label}, and
-@samp{search --fs-uuid} respectively.
+The (@option{-p}, @option{--part-uuid}) option is currently only implemented
+for MSDOS and GPT formatted disks.
+
+The (@option{--part-label}) option is currently only implemented for GPT
+formatted disks, and compares only first 36 characters of partition name.
+
+The @samp{search.file}, @samp{search.fs_label}, @samp{search.part_label},
+@samp{search.fs_uuid}, and @samp{search.part_uuid} commands are aliases
+for @samp{search --file}, @samp{search --label}, @samp{search --part-label},
+@samp{search --fs-uuid}, and @samp{search --part-uuid} respectively.
Also hints as to which device may be the most likely to contain the item
searched for may be given via the (@option{-h}, @option{--hint}) option with
--
2.34.1
_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel
