From patchwork Sat Oct 14 13:00:02 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Christina O'Donnell X-Patchwork-Id: 54824 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 81F8B27BBEA; Sat, 14 Oct 2023 15:56:52 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, SPF_HELO_PASS autolearn=ham autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id DA42227BBE2 for ; Sat, 14 Oct 2023 15:56:46 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qrg47-0002nP-LO; Sat, 14 Oct 2023 10:56:31 -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 1qreqq-0004vZ-RU for guix-patches@gnu.org; Sat, 14 Oct 2023 09:38:45 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qreqk-000385-Sz for guix-patches@gnu.org; Sat, 14 Oct 2023 09:38:44 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qrer8-000116-Es for guix-patches@gnu.org; Sat, 14 Oct 2023 09:39:02 -0400 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 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-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 X-Mailman-Approved-At: Sat, 14 Oct 2023 10:56:29 -0400 X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * 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(-) base-commit: 8e8d20b6b35d3ab529f9045cc8a779cdcec9c471 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