GNU bug report logs - #66540
[DOCUMENTATION] doc: Expand origin-Reference section

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 66540 in the body.
You can then email your comments to 66540 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Christina O'Donnell <cdo <at> mutix.org>
To: guix-patches <at> gnu.org
Cc: Christina O'Donnell <cdo <at> mutix.org>
Subject: [DOCUMENTATION] doc: Expand origin-Reference section
Date: Sat, 14 Oct 2023 14:00:02 +0100

* doc/guix.texi (origin Reference): Add references for hg-reference,
svn-reference, bzr-fetch, and bzr-reference.
---
 doc/guix.texi | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 73 insertions(+), 1 deletion(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 083504dcb8..531039ad33 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -8530,9 +8530,81 @@ origin Reference
 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}.
+the file name, or a generic name if @code{#f}.
+@end deffn
+
+@deftp {Data Type} hg-reference
+This data type represents a Mercurial reference for @code{hg-fetch} to
+retrieve.
+
+@table @asis
+@item @code{url}
+The URL of the Mercurial repository to clone.
+
+@item @code{revision}
+This string denotes revision to fetch specified as a number.
+@end table
+@end deftp
+
+For Subversion repositories, the module @code{(guix svn-download)}
+defines the @code{svn-fetch} origin method and @code{svn-reference} data
+type for support of the Subversion version control system.
+
+@deffn {Procedure} svn-fetch ref hash-algo hash [name]
+Return a fixed-output derivation that fetches @var{ref}, a
+@code{<svn-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} svn-reference
+This data type represents a Subversion reference for @code{svn-fetch} to
+retrieve.
+
+@table @asis
+@item @code{url}
+The URL of the Subversion repository to clone.
+
+@item @code{revision}
+This string denotes revision to fetch specified as a number.
+
+@item @code{recursive?} (default: @code{#f})
+This Boolean indicates whether to recursively fetch Subversion
+sub-modules.
+
+@item @code{user-name} (default: @code{#f})
+The name of an account that has read-access to the repository, if the
+repository isn't public.
+
+@item @code{password} (default: @code{#f})
+Password to access the Subversion repository, if required.
+@end table
+@end deftp
+
+For Bazaar repositories, the module @code{(guix bzr-download)}
+defines the @code{bzr-fetch} origin method and @code{bzr-reference} data
+type for support of the Bazaar version control system.
+
+@deffn {Procedure} bzr-fetch ref hash-algo hash [name]
+Return a fixed-output derivation that fetches @var{ref}, a
+@code{<bzr-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} bzr-reference
+This data type represents a Bazaar reference for @code{bzr-fetch} to
+retrieve.
+
+@table @asis
+@item @code{url}
+The URL of the Bazaar repository to clone.
+
+@item @code{revision}
+This string denotes revision to fetch specified as a number.
+@end table
+@end deftp
+
 @node Defining Package Variants
 @section Defining Package Variants
 

base-commit: 8e8d20b6b35d3ab529f9045cc8a779cdcec9c471
-- 
2.41.0

Message #8 received at 66540 <at> debbugs.gnu.org (full text, mbox):

From: Christina O'Donnell <cdo <at> mutix.org>
To: 66540 <at> debbugs.gnu.org
Cc: janneke <at> gnu.org
Subject: [DOCUMENTATION] doc: Expand origin-Reference section
Date: Sat, 14 Oct 2023 16:34:12 +0100

[Message part 1 (text/html, inline)]

Message #13 received at 66540-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Christina O'Donnell <cdo <at> mutix.org>
Cc: 66540-done <at> debbugs.gnu.org
Subject: Re: bug#66540: [DOCUMENTATION] doc: Expand origin-Reference section
Date: Wed, 18 Oct 2023 23:11:19 +0200

[Message part 1 (text/plain, inline)]

Hi Christina,

Christina O'Donnell <cdo <at> mutix.org> skribis:

> * doc/guix.texi (origin Reference): Add references for hg-reference,
> svn-reference, bzr-fetch, and bzr-reference.

This looks great to me.

For ‘svn-reference’, I had to check the code: when ‘recursive?’ is
false, “--ignore-externals” is passed to ‘svn’.  I have a vague
recollection of “externals” being akin to submodules in Git.  Anyway, I
modified the patch as shown below.

Applied now, thank you!

Ludo’.

[Message part 2 (text/x-patch, inline)]

diff --git a/doc/guix.texi b/doc/guix.texi
index 24ee1dc702..91408b8e62 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -8573,7 +8573,7 @@ origin Reference
 
 @item @code{recursive?} (default: @code{#f})
 This Boolean indicates whether to recursively fetch Subversion
-sub-modules.
+``externals''.
 
 @item @code{user-name} (default: @code{#f})
 The name of an account that has read-access to the repository, if the

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.