From patchwork Wed May 26 09:00:25 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Xinglu Chen X-Patchwork-Id: 29603 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 7B95627BC78; Wed, 26 May 2021 10:01:09 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,SPF_HELO_PASS, T_DKIM_INVALID,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id DFA5127BC81 for ; Wed, 26 May 2021 10:01:08 +0100 (BST) Received: from localhost ([::1]:59070 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1llpPY-0005Ml-32 for patchwork@mira.cbaines.net; Wed, 26 May 2021 05:01:08 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53168) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1llpPS-0005MG-HD for guix-patches@gnu.org; Wed, 26 May 2021 05:01:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:36066) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1llpPS-0008HY-9a for guix-patches@gnu.org; Wed, 26 May 2021 05:01:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1llpPS-00039d-6p for guix-patches@gnu.org; Wed, 26 May 2021 05:01:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#48667] [PATCH] doc: Expound on how to specify the version of a package. Resent-From: Xinglu Chen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Wed, 26 May 2021 09:01:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 48667 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 48667@debbugs.gnu.org X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.162201963912079 (code B ref -1); Wed, 26 May 2021 09:01:02 +0000 Received: (at submit) by debbugs.gnu.org; 26 May 2021 09:00:39 +0000 Received: from localhost ([127.0.0.1]:47612 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1llpP5-00038l-Fk for submit@debbugs.gnu.org; Wed, 26 May 2021 05:00:39 -0400 Received: from lists.gnu.org ([209.51.188.17]:46564) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1llpP3-00038d-Is for submit@debbugs.gnu.org; Wed, 26 May 2021 05:00:38 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53068) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1llpP3-0005KB-8Y for guix-patches@gnu.org; Wed, 26 May 2021 05:00:37 -0400 Received: from h87-96-130-155.cust.a3fiber.se ([87.96.130.155]:39724 helo=mail.yoctocell.xyz) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1llpOw-0007wq-Pk for guix-patches@gnu.org; Wed, 26 May 2021 05:00:37 -0400 From: Xinglu Chen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=yoctocell.xyz; s=mail; t=1622019626; bh=jZgbZg/9cr6H7r4QGEQsGtE9CCmBIs11z3X8h6qcV18=; h=From:To:Subject:Date; b=ZJoJq8Ymwdxf/euERn3L2alB8PKCoZ91Y1dfnPyMTs/cuT/+Jhkp6VMVg7T/bzt9c CQFMMgQUxHd5zUhAa7tDiooqvbm87eYmPjDGWFVzo/Nna+EuSaBTP5hRhdllH/TcOF 4TIUfSmuD5ghWvpgcTUrhplR60wROmzP5BZabfn4= Message-Id: <06217762b07f95d2ba2d40277d010647a926df68.1622019402.git.public@yoctocell.xyz> Date: Wed, 26 May 2021 11:00:25 +0200 MIME-Version: 1.0 Received-SPF: pass client-ip=87.96.130.155; envelope-from=public@yoctocell.xyz; helo=mail.yoctocell.xyz X-Spam_score_int: 33 X-Spam_score: 3.3 X-Spam_bar: +++ X-Spam_report: (3.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FROM_SUSPICIOUS_NTLD=0.498, FROM_SUSPICIOUS_NTLD_FP=1.896, PDS_OTHER_BAD_TLD=1.997, RDNS_DYNAMIC=0.982, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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" X-getmail-retrieved-from-mailbox: Patches * doc/guix.texi (package Reference): Describe how packages that lack a release or are pinned to an unreleased version should specify the ‘version’ field. Add documentation for the ‘git-version’ procedure. --- I am unsure if the format for packages that don’t have a release should be ‘0.0.0-REVISION.COMMIT’ or just ‘0-REVISION.COMMIT’. doc/guix.texi | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) base-commit: 3f2a4b098039bd374c76d524223de3c6c475f23e diff --git a/doc/guix.texi b/doc/guix.texi index e8b0485f78..083f65c9c5 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -89,6 +89,7 @@ Copyright @copyright{} 2020 Jonathan Brielmaier@* Copyright @copyright{} 2020 Edgar Vincent@* Copyright @copyright{} 2021 Maxime Devos@* Copyright @copyright{} 2021 B. Wilson@* +Copyright @copyright{} 2021 Xinglu Chen@* Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or @@ -6651,7 +6652,18 @@ This is the data type representing a package recipe. The name of the package, as a string. @item @code{version} -The version of the package, as a string. +The version of the package, as a string. If there are no releases of +the package, or a unreleased version is desired, the version should +contain @code{VERSION-REVISION.COMMIT}. @code{VERSION} is +@c TODO: 0.0.0 or just 0 ? +@code{0.0.0} or whatever the latest version is, and @code{REVISION} is +the revision of the Guix package (@code{0} if it is a new package), +whenever the package is updated to a newer version the revision should +also be bumped. @code{COMMIT} is the @dfn{commit} or @dfn{changeset} +corresponding to the version, it should only contain 7 characters. If +the fetch method is @code{git-fetch} (@pxref{origin Reference}), there +is the @code{git-version} procedure that makes it easier to specify the +version. @item @code{source} An object telling how the source code for the package should be @@ -6757,6 +6769,15 @@ automatically corrected. @end table @end deftp +@deffn {Scheme Procedure} git-version @var{VERSION} @var{REVISION} @var{COMMIT} +Return the version string for packages using @code{git-fetch}. + +@example +(git-version "0.0.0" "0" "93818c936ee7e2f1ba1b315578bde363a7d43d05") +@result{} "0.0.0-0.93818c9" +@end example +@end deffn + @deffn {Scheme Syntax} this-package When used in the @emph{lexical scope} of a package field definition, this identifier resolves to the package being defined.