02/02: doc: Document hg-fetch.

[guix-commits]

cbaines pushed a commit to branch master
in repository guix.

commit 289b20ef62ce1d23befcf2593b191e2a686c7b6c
Author: Holger Peters <holger.peters@posteo.de>
AuthorDate: Sun Nov 1 10:50:25 2020 +0100

    doc: Document hg-fetch.
    
    * doc/guix.texi (origin Reference): Add documentation for hg-fetch.
    
    Signed-off-by: Christopher Baines <mail@cbaines.net>
---
 doc/guix.texi | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/guix.texi b/doc/guix.texi
index bbc9523..8440fff 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