diff mbox series

[bug#68353,v2,1/2] doc: Document cvs-fetch and cvs-reference.

Message ID 82ec854214fad37f82bc18d4424ac61f82da3f1a.1715507861.git.~@wolfsden.cz
State New
Headers show
Series [bug#68353,v2,1/2] doc: Document cvs-fetch and cvs-reference. | expand

Commit Message

Tomas Volf May 12, 2024, 9:57 a.m. UTC
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
---
 doc/guix.texi | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

Comments

Ludovic Courtès May 13, 2024, 12:45 p.m. UTC | #1
Tomas Volf <~@wolfsden.cz> skribis:

> 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

[...]

> The field is called changeset, not revision.  And the string does not have to
> be a number.
>
> * doc/guix.texi (origin Reference): Fix documentation for hg-reference.
>
> Change-Id: Ic622dfc7b44caf42d070cdab8e42808dd96e6d63

Applied, thanks!
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index f20208f94f..bc73942eaf 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -8302,6 +8302,43 @@  origin Reference
 @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