doc: Format 'guix hash -S' values as a table.

* doc/guix.texi (Invoking guix hash): Format serializer types as a
table.
This commit is contained in:
Ludovic Courtès 2021-12-17 17:15:16 +01:00
parent 28ffdc5cc8
commit 4204156eb4
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5

View file

@ -11758,18 +11758,27 @@ legacy alias for @var{type} sets to @code{nar}.
@itemx -S @itemx -S
Compute the hash on @var{file} using @var{type} serialization. Compute the hash on @var{file} using @var{type} serialization.
Supported types: @code{none}, @code{nar} and @code{git}. @var{type} may be one of the following:
When using @code{nar}, the hash is computed on an archive containing @table @code
@item none
This is the default: it computes the hash of a file's contents.
@item nar
Compute the hash of a ``normalized archive'' (or ``nar'') containing
@var{file}, including its children if it is a directory. Some of the @var{file}, including its children if it is a directory. Some of the
metadata of @var{file} is part of the archive; for instance, when metadata of @var{file} is part of the archive; for instance, when
@var{file} is a regular file, the hash is different depending on whether @var{file} is a regular file, the hash is different depending on whether
@var{file} is executable or not. Metadata such as time stamps has no @var{file} is executable or not. Metadata such as time stamps has no
impact on the hash (@pxref{Invoking guix archive}). impact on the hash (@pxref{Invoking guix archive}, for more info on the
nar format).
@c FIXME: Replace xref above with xref to an ``Archive'' section when @c FIXME: Replace xref above with xref to an ``Archive'' section when
@c it exists. @c it exists.
Using @code{git} serializes the file or directory as a Git tree. @item git
Compute the has of the file or directory as a Git ``tree'', following
the same method as the Git version control system.
@end table
@item --exclude-vcs @item --exclude-vcs
@itemx -x @itemx -x