summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTomas Volf <~@wolfsden.cz>2024-05-12 11:57:40 +0200
committerLudovic Courtès <ludo@gnu.org>2024-05-13 16:31:34 +0200
commit408c4511a6aa212c731280a83e0169ac3b8777f3 (patch)
tree7343f8016db5c856623553fd314e3610eaa58c32 /doc
parent7757fdd491862fa5c33f1f894503346b89898a01 (diff)
doc: Document cvs-fetch and cvs-reference.
For some reason, they were missing from the documentation. This commit adds them including an example of usage. * doc/guix.texi (origin Reference): Add cvs-fetch and cvs-reference. Change-Id: I6622a9f70e6d71ed31fbb3d2689df4a6946f8868 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index ce1a06747c..a0b171e7f0 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -8302,6 +8302,43 @@ This string denotes revision to fetch specified as a number.
@end table
@end deftp
+For CVS repositories, the module @code{(guix cvs-download)} defines the
+@code{cvs-fetch} origin method and @code{cvs-reference} data type for
+support of the Concurrent Versions System (CVS).
+
+@deffn {Procedure} cvs-fetch ref hash-algo hash [name]
+Return a fixed-output derivation that fetches @var{ref}, a
+@code{<cvs-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{#f}.
+@end deffn
+
+@deftp {Data Type} cvs-reference
+This data type represents a CVS reference for @code{cvs-fetch} to
+retrieve.
+
+@table @asis
+@item @code{root-directory}
+The CVS root directory.
+
+@item @code{module}
+Module to fetch.
+
+@item @code{revision}
+Revision to fetch.
+@end table
+
+The example below denotes a version of gnu-standards to fetch:
+
+@lisp
+(cvs-reference
+ (root-directory ":pserver:anonymous@@cvs.savannah.gnu.org:/sources/gnustandards")
+ (module "gnustandards")
+ (revision "2020-11-25"))
+@end lisp
+
+@end deftp
+
@node Defining Package Variants
@section Defining Package Variants