summary refs log tree commit diff
diff options
context:
space:
mode:
authorHolger Peters <holger.peters@posteo.de>2020-11-01 10:50:25 +0100
committerChristopher Baines <mail@cbaines.net>2020-11-14 10:27:00 +0000
commit289b20ef62ce1d23befcf2593b191e2a686c7b6c (patch)
treef4105e690315b4ffe1b43022e87fa649338308f3
parent521d33cdc6965ac5ce786cedc26e247eb8b6f4ee (diff)
downloadguix-289b20ef62ce1d23befcf2593b191e2a686c7b6c.tar.gz
doc: Document hg-fetch.
* doc/guix.texi (origin Reference): Add documentation for hg-fetch.

Signed-off-by: Christopher Baines <mail@cbaines.net>
-rw-r--r--doc/guix.texi12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index bbc9523bde..8440ffffc7 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -6835,6 +6835,18 @@ commit:
 @end lisp
 @end deftp
 
+For Mercurial repositories, the module @code{(guix hg-download)} defines
+the @code{hg-fetch} origin method and @code{hg-reference} data type for
+support of the Mercurial version control system.
+
+@deffn {Scheme Procedure} hg-fetch @var{ref} @var{hash-algo} @var{hash} @
+           [name]
+Return a fixed-output derivation that fetches @var{ref}, a
+@code{<hg-reference>} object.  The output is expected to have recursive
+hash @var{hash} of type @var{hash-algo} (a symbol).  Use @var{name} as
+the file name, or a generic name if @code{#false}.
+@end deffn
+
 @node Defining Package Variants
 @section Defining Package Variants