From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id NPmENdneu2CnTgAAgWs5BA (envelope-from ) for ; Sat, 05 Jun 2021 22:30:17 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id gKUxMNneu2CNPQAAB5/wlQ (envelope-from ) for ; Sat, 05 Jun 2021 20:30:17 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 3A98B21F0F for ; Sat, 5 Jun 2021 22:30:17 +0200 (CEST) Received: from localhost ([::1]:42288 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lpcvv-0008RB-PT for larch@yhetil.org; Sat, 05 Jun 2021 16:30:15 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52378) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lpcvj-0008Ql-6N for guix-patches@gnu.org; Sat, 05 Jun 2021 16:30:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:38582) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lpcvi-0005HO-Ux for guix-patches@gnu.org; Sat, 05 Jun 2021 16:30:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lpcvi-0007nE-L8 for guix-patches@gnu.org; Sat, 05 Jun 2021 16:30: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: Ludovic =?UTF-8?Q?Court=C3=A8s?= Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 05 Jun 2021 20:30:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 48667 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: Xinglu Chen Cc: 48667@debbugs.gnu.org, Nicolas Goaziou Received: via spool by 48667-submit@debbugs.gnu.org id=B48667.162292495529873 (code B ref 48667); Sat, 05 Jun 2021 20:30:02 +0000 Received: (at 48667) by debbugs.gnu.org; 5 Jun 2021 20:29:15 +0000 Received: from localhost ([127.0.0.1]:50125 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lpcux-0007ll-Ak for submit@debbugs.gnu.org; Sat, 05 Jun 2021 16:29:15 -0400 Received: from eggs.gnu.org ([209.51.188.92]:58688) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lpcuv-0007lY-Ho for 48667@debbugs.gnu.org; Sat, 05 Jun 2021 16:29:14 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]:57830) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lpcup-0004dr-4V; Sat, 05 Jun 2021 16:29:07 -0400 Received: from [2a01:e0a:1d:7270:af76:b9b:ca24:c465] (port=53418 helo=ribbon) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lpcuo-0000yb-Rz; Sat, 05 Jun 2021 16:29:07 -0400 From: Ludovic =?UTF-8?Q?Court=C3=A8s?= References: <06217762b07f95d2ba2d40277d010647a926df68.1622019402.git.public@yoctocell.xyz> <7a6a9bffa80fdfaa1e14015614cb638ff8cc7441.1622040691.git.public@yoctocell.xyz> Date: Sat, 05 Jun 2021 22:29:05 +0200 In-Reply-To: <7a6a9bffa80fdfaa1e14015614cb638ff8cc7441.1622040691.git.public@yoctocell.xyz> (Xinglu Chen's message of "Wed, 26 May 2021 16:57:57 +0200") Message-ID: <87zgw4m4xa.fsf_-_@gnu.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable 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+larch=yhetil.org@gnu.org Sender: "Guix-patches" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1622925017; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post; bh=myPf2dhl7+eKeS6n3FTKeYAhAZ45SeFDy4XvuU6yICM=; b=af7fzNcPEtAdF3f6+cH7z6bNV1r8NCrwnABifvlrMYPRKPSSujytbK91fkn6eMIHScJKDN yHAFGrgf9H3hYfHjkWIksnXr4q35ZDqTxPutCRrK00dm/YnjnlYgT8ZbJvU7Lc5WJDfKZv PBnH1hF8T/zZblYjV9EnNFINZBjLWpflE7+WaRkpP5Ty/+M2W6Qfp4W9Nv254awGUtgSiU TBguGm3ZG9GdM3errAdW88RRhFAJpL7kZRDSx/TGJGJ9kdTwq18Q8ZEfeNTGskIeFGZT7p jr27cRig83UKw1+E+2QZ8zbS2pRK5qvhGuIWRogPlruLPJYkOAf7ggBFjOQNSQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1622925017; a=rsa-sha256; cv=none; b=WitbtqTW/RP1zI/+uyLpK3bXu3uCCUAshCkdyZqkN54SmU8DCE8A29M+HJB6JwO0dk56oP 5HiEoSpoMh5fr4/in/AXMfmORD7e9R1fM3MG1PKRVFVinG8yhceGndkbdlfYaBlvHAr/U2 0xlEtgh4mexyzvDhqIYi1YYpX8xoEQdDBUVYiPWADARIvt4mMre7teiX6CwwCUW436GkNm VfpUo+4qE1fw5LTYV+AbRpGNQODy+h2rhOwdxtSHs3Tx+9BSWuTI79LvFutRnMMoNx9qsO feV2Sh8+zfiTr3DpEX/lYfFQVYBlFi8/jYqeKn9D84cWNYj/x8PbHGKPZTBAAQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Spam-Score: -1.43 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Queue-Id: 3A98B21F0F X-Spam-Score: -1.43 X-Migadu-Scanner: scn1.migadu.com X-TUID: tX1jRpSl2tEF Hi Xinglu, Xinglu Chen skribis: > * doc/guix.texi (package Reference): Describe how packages that lack a re= lease > or are pinned to an unreleased version should specify the =E2=80=98versio= n=E2=80=99 field. > Add documentation for the =E2=80=98git-version=E2=80=99 procedure. [...] > @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 @samp{@var{VERSION}-@var{REVISION}.@var{COMMIT}}. @var{VERSION} > +is the version of the package, and @var{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 to reflect > +the fact that package has been updated. If the fetch method for the > +package is @code{git-fetch} or @code{hg-fetch} (@pxref{origin > +Reference}), @var{COMMIT} should be the @dfn{commit} or @dfn{changeset} > +corresponding to the version, it should only contain 7 characters. If > +the fetch method is @code{git-fetch}, there is the @code{git-version} > +procedure (see below) that makes it easier to specify the version. > +Packages which use @code{svn-fetch} or @code{bzr-fetch} should set > +@var{COMMIT} to the same value as the @code{revision} field in > +@code{svn-reference} or @code{bzr-reference}. The text LGTM, but I think =E2=80=9Cpackage Reference=E2=80=9D is the wrong= place for it: it=E2=80=99s the reference, whereas the text above is a guideline. The =E2=80=9CVersion Numbers=E2=80=9D section under =E2=80=9CPackaging Guid= elines=E2=80=9D already touches this topic. Perhaps we need to expand it and/or link to it from =E2=80=9Cpackage Reference=E2=80=9D, like: @item @code{version} The version of the package, as a string. @xref{Version Numbers}, for guidelines. The =E2=80=98git-version=E2=80=99 procedure could be documented in =E2=80= =9CVersion Numbers=E2=80=9D too. WDYT? Thanks, Ludo=E2=80=99.