From unknown Sun Jun 22 07:52:40 2025 X-Loop: help-debbugs@gnu.org Subject: [bug#66540] [DOCUMENTATION] doc: Expand origin-Reference section Resent-From: Christina O'Donnell Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 14 Oct 2023 13:39:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 66540 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: To: 66540@debbugs.gnu.org Cc: Christina O'Donnell X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.16972906923815 (code B ref -1); Sat, 14 Oct 2023 13:39:02 +0000 Received: (at submit) by debbugs.gnu.org; 14 Oct 2023 13:38:12 +0000 Received: from localhost ([127.0.0.1]:48216 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qreqI-0000zQ-A6 for submit@debbugs.gnu.org; Sat, 14 Oct 2023 09:38:12 -0400 Received: from lists.gnu.org ([2001:470:142::17]:45232) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qreJU-0007bV-Vn for submit@debbugs.gnu.org; Sat, 14 Oct 2023 09:04:21 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qreJ1-0004G5-FR for guix-patches@gnu.org; Sat, 14 Oct 2023 09:03:47 -0400 Received: from vmi993448.contaboserver.net ([194.163.141.236] helo=mutix.org) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qreIz-0005Pe-Nx for guix-patches@gnu.org; Sat, 14 Oct 2023 09:03:47 -0400 Received: from peter.home (host217-46-73-119.range217-46.btcentralplus.com [217.46.73.119]) (Authenticated sender: cdo) by mutix.org (Postfix) with ESMTPSA id 136D8A6011D; Sat, 14 Oct 2023 15:03:41 +0200 (CEST) From: Christina O'Donnell Date: Sat, 14 Oct 2023 14:00:02 +0100 Message-ID: X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-1.0 required=5.0 tests=ALL_TRUSTED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on algernon.mutix.org Received-SPF: pass client-ip=194.163.141.236; envelope-from=cdo@mutix.org; helo=mutix.org X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 1.0 (+) X-Mailman-Approved-At: Sat, 14 Oct 2023 09:38:08 -0400 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) * 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{} 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{} 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{} 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 From unknown Sun Jun 22 07:52:40 2025 X-Loop: help-debbugs@gnu.org Subject: [bug#66540] [DOCUMENTATION] doc: Expand origin-Reference section References: In-Reply-To: Resent-From: Christina O'Donnell Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 14 Oct 2023 17:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66540 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: To: 66540@debbugs.gnu.org Cc: janneke@gnu.org Received: via spool by 66540-submit@debbugs.gnu.org id=B66540.169730497313766 (code B ref 66540); Sat, 14 Oct 2023 17:37:02 +0000 Received: (at 66540) by debbugs.gnu.org; 14 Oct 2023 17:36:13 +0000 Received: from localhost ([127.0.0.1]:50401 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qriYd-0003Zw-NN for submit@debbugs.gnu.org; Sat, 14 Oct 2023 13:36:13 -0400 Received: from vmi993448.contaboserver.net ([194.163.141.236]:36140 helo=mutix.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qrgf0-0007xu-V7 for 66540@debbugs.gnu.org; Sat, 14 Oct 2023 11:34:41 -0400 Received: from [192.168.1.166] (host217-46-73-119.range217-46.btcentralplus.com [217.46.73.119]) (Authenticated sender: cdo) by mutix.org (Postfix) with ESMTPSA id 55A97A62B03; Sat, 14 Oct 2023 17:34:13 +0200 (CEST) Message-ID: <0d9ee251-1a10-a3fb-ce15-3beb6c7d1399@mutix.org> Date: Sat, 14 Oct 2023 16:34:12 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.12.0 Content-Language: en-US From: Christina O'Donnell Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-0.9 required=5.0 tests=ALL_TRUSTED,HTML_MESSAGE, MIME_HTML_ONLY,URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on algernon.mutix.org X-Spam-Score: 0.1 (/) X-Mailman-Approved-At: Sat, 14 Oct 2023 13:36:11 -0400 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.9 (/)

Err I forgot to add details..

Hi Guix,

This is my first patch to Guix. Janneke asked me to fill in the documentation for `svn-fetch`.

This patch should contain the documentation for:

 - `hg-reference`
 - `svn-fetch`
 - `svn-reference`
 - `bzr-fetch`
 - `bzr-reference`

This should now cover all currently supported origin methods:

 - local
 - Git
 - Mercurial
 - Subversion
 - Bazaar

One thing I was unsure about was whether `svn-reference` had a field `recursive?`. However, from what I could find, Subversion has no equivalent to Git's sub-modules. However, I documented Subversion's `recursive?` with what it would do if it did anything sensible.

I would be delighted to make any corrections needed!

Kind regards,
 - Christina O'Donnell

From unknown Sun Jun 22 07:52:40 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: Christina O'Donnell Subject: bug#66540: closed (Re: bug#66540: [DOCUMENTATION] doc: Expand origin-Reference section) Message-ID: References: <87pm1b4ow8.fsf@gnu.org> X-Gnu-PR-Message: they-closed 66540 X-Gnu-PR-Package: guix-patches Reply-To: 66540@debbugs.gnu.org Date: Wed, 18 Oct 2023 21:12:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1697663522-3343-1" This is a multi-part message in MIME format... ------------=_1697663522-3343-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #66540: [DOCUMENTATION] doc: Expand origin-Reference section which was filed against the guix-patches package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 66540@debbugs.gnu.org. --=20 66540: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D66540 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1697663522-3343-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 66540-done) by debbugs.gnu.org; 18 Oct 2023 21:11:59 +0000 Received: from localhost ([127.0.0.1]:34777 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qtDpf-0000ri-EF for submit@debbugs.gnu.org; Wed, 18 Oct 2023 17:11:59 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:60354) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qtDpa-0000rR-1s for 66540-done@debbugs.gnu.org; Wed, 18 Oct 2023 17:11:57 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qtDp4-0006AG-09; Wed, 18 Oct 2023 17:11:22 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Date:References:In-Reply-To:Subject:To: From; bh=sRoT2RjcXtMMTH80iRrGGANR7thU194J4WTPgvFLvfk=; b=X+AMNUg9XU/kNDFT+iyS qVruBvoOD6kE+dwa7x1+tPRrXt/RpPDiJoGBmGXm7pbjzQ4VuDovdOMvGTiT2B2FtXGnjI+s25nLH ZTgOYKI2rgTOmS+2THNyxn40X8mZxdWHmT0peQ0d3ZNvCEx8XBOu1c2dfroFldmm2jzRfqFh6a9cZ aUqDBk0EVLVmttjb5sHElxqCYzOYmfK1jpImV8+nQGIJmW+IK0QJOySiacnISEcJp1O4a80TanI0w 50ED6GEjMXKDkKci7f78W6j0zIDPvb7PIBjwksjY2Wl4EuKhWpOwtUlzy50U/4AKLAds9Xcq+MA0M vyrYd5zx2TOrlg==; From: =?utf-8?Q?Ludovic_Court=C3=A8s?= To: Christina O'Donnell Subject: Re: bug#66540: [DOCUMENTATION] doc: Expand origin-Reference section In-Reply-To: (Christina O'Donnell's message of "Sat, 14 Oct 2023 14:00:02 +0100") References: Date: Wed, 18 Oct 2023 23:11:19 +0200 Message-ID: <87pm1b4ow8.fsf@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 66540-done Cc: 66540-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Hi Christina, Christina O'Donnell skribis: > * doc/guix.texi (origin Reference): Add references for hg-reference, > svn-reference, bzr-fetch, and bzr-reference. This looks great to me. For =E2=80=98svn-reference=E2=80=99, I had to check the code: when =E2=80= =98recursive?=E2=80=99 is false, =E2=80=9C--ignore-externals=E2=80=9D is passed to =E2=80=98svn=E2=80= =99. I have a vague recollection of =E2=80=9Cexternals=E2=80=9D being akin to submodules in Git= . Anyway, I modified the patch as shown below. Applied now, thank you! Ludo=E2=80=99. --=-=-= Content-Type: text/x-patch Content-Disposition: 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 --=-=-=-- ------------=_1697663522-3343-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 14 Oct 2023 13:38:12 +0000 Received: from localhost ([127.0.0.1]:48216 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qreqI-0000zQ-A6 for submit@debbugs.gnu.org; Sat, 14 Oct 2023 09:38:12 -0400 Received: from lists.gnu.org ([2001:470:142::17]:45232) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qreJU-0007bV-Vn for submit@debbugs.gnu.org; Sat, 14 Oct 2023 09:04:21 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qreJ1-0004G5-FR for guix-patches@gnu.org; Sat, 14 Oct 2023 09:03:47 -0400 Received: from vmi993448.contaboserver.net ([194.163.141.236] helo=mutix.org) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qreIz-0005Pe-Nx for guix-patches@gnu.org; Sat, 14 Oct 2023 09:03:47 -0400 Received: from peter.home (host217-46-73-119.range217-46.btcentralplus.com [217.46.73.119]) (Authenticated sender: cdo) by mutix.org (Postfix) with ESMTPSA id 136D8A6011D; Sat, 14 Oct 2023 15:03:41 +0200 (CEST) From: Christina O'Donnell To: guix-patches@gnu.org Subject: [DOCUMENTATION] doc: Expand origin-Reference section Date: Sat, 14 Oct 2023 14:00:02 +0100 Message-ID: X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-1.0 required=5.0 tests=ALL_TRUSTED autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on algernon.mutix.org Received-SPF: pass client-ip=194.163.141.236; envelope-from=cdo@mutix.org; helo=mutix.org X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 1.0 (+) X-Debbugs-Envelope-To: submit X-Mailman-Approved-At: Sat, 14 Oct 2023 09:38:08 -0400 Cc: Christina O'Donnell X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.0 (/) * 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{} 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{} 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{} 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 ------------=_1697663522-3343-1--