[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[bug#44367] [PATCH 2/2] doc: Document hg-fetch
From: |
Holger Peters |
Subject: |
[bug#44367] [PATCH 2/2] doc: Document hg-fetch |
Date: |
Sun, 1 Nov 2020 10:50:25 +0100 |
* doc/guix.texi (hg-fetch): Add documentation for scheme procedure.
---
doc/guix.texi | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/doc/guix.texi b/doc/guix.texi
index 69e7d5f85c..cb58ba85c6 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -6834,6 +6834,17 @@ 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}
+Return a fixed-output derivation that fetches @var{ref}, a
+@code{<hg-reference>} object. @code{<git-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
--
2.28.0