From 4204156eb4c1afd5365ef505e356f87daa91787d Mon Sep 17 00:00:00 2001 From: Ludovic Courtès Date: Fri, 17 Dec 2021 17:15:16 +0100 Subject: doc: Format 'guix hash -S' values as a table. * doc/guix.texi (Invoking guix hash): Format serializer types as a table. --- doc/guix.texi | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/guix.texi b/doc/guix.texi index 31a23874b1..aca88cdada 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -11758,18 +11758,27 @@ legacy alias for @var{type} sets to @code{nar}. @itemx -S 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 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 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 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 @itemx -x -- cgit 1.4.1