doc: cookbook: Mention "guix hash -rx" for Git checkouts.
authorLudovic Courtès <ludovic.courtes@inria.fr>
Mon, 22 Jun 2020 14:40:18 +0000 (16:40 +0200)
committerLudovic Courtès <ludo@gnu.org>
Mon, 22 Jun 2020 22:03:08 +0000 (00:03 +0200)
* doc/guix-cookbook.texi (Extended example): Mention "guix hash -rx ."

doc/guix-cookbook.texi

index 31c4cd4..efafbd9 100644 (file)
@@ -852,6 +852,24 @@ version when packaging programs for a specific commit, following the
 Guix contributor guidelines (@pxref{Version Numbers,,, guix, GNU Guix
 Reference Manual}).
 
+How does one obtain the @code{sha256} hash that's in there, you ask?  By
+invoking @command{guix hash} on a checkout of the desired commit, along
+the lines:
+
+@example
+git clone https://github.com/libgit2/libgit2/
+cd libgit2
+git checkout v0.26.6
+guix hash -rx .
+@end example
+
+@command{guix hash -rx} computes a SHA256 hash over the whole directory,
+excluding the @file{.git} sub-directory (@pxref{Invoking guix hash,,,
+guix, GNU Guix Reference Manual}).
+
+In the future, @command{guix download} will hopefully be able to do
+these steps for you, just like it does for regular downloads.
+
 @subsubsection Snippets
 
 Snippets are quoted (i.e. non-evaluated) Scheme code that are a means of patching