doc: Explain 'guix hash -r' for Git checkouts.
* doc/guix.texi (origin Reference): Add xref to "guix download" and "guix hash". (Invoking guix hash): Provide an example to compute the hash of a Git checkout. Co-authored-by: Troy Sankey <sankeytms@gmail.com>
This commit is contained in:
parent
2d94702ff4
commit
db97a03a89
|
@ -2669,6 +2669,7 @@ Examples include:
|
|||
download a file from the HTTP, HTTPS, or FTP URL specified in the
|
||||
@code{uri} field;
|
||||
|
||||
@vindex git-fetch
|
||||
@item @var{git-fetch} from @code{(guix git-download)}
|
||||
clone the Git version control repository, and check out the revision
|
||||
specified in the @code{uri} field as a @code{git-reference} object; a
|
||||
|
@ -2686,6 +2687,10 @@ A bytevector containing the SHA-256 hash of the source. Typically the
|
|||
@code{base32} form is used here to generate the bytevector from a
|
||||
base-32 string.
|
||||
|
||||
You can obtain this information using @code{guix download}
|
||||
(@pxref{Invoking guix download}) or @code{guix hash} (@pxref{Invoking
|
||||
guix hash}).
|
||||
|
||||
@item @code{file-name} (default: @code{#f})
|
||||
The file name under which the source code should be saved. When this is
|
||||
@code{#f}, a sensible default value will be used in most cases. In case
|
||||
|
@ -4569,6 +4574,17 @@ hash (@pxref{Invoking guix archive}).
|
|||
@c FIXME: Replace xref above with xref to an ``Archive'' section when
|
||||
@c it exists.
|
||||
|
||||
@vindex git-fetch
|
||||
As an example, here is how you would compute the hash of a Git checkout,
|
||||
which is useful when using the @code{git-fetch} method (@pxref{origin
|
||||
Reference}):
|
||||
|
||||
@example
|
||||
$ git clone http://example.org/foo.git
|
||||
$ cd foo
|
||||
$ rm -rf .git
|
||||
$ guix hash -r .
|
||||
@end example
|
||||
@end table
|
||||
|
||||
@node Invoking guix import
|
||||
|
|
Loading…
Reference in New Issue