From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id UIQHCy+RvGC5AwAAgWs5BA (envelope-from ) for ; Sun, 06 Jun 2021 11:11:11 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id +G6hBi+RvGC7AQAA1q6Kng (envelope-from ) for ; Sun, 06 Jun 2021 09:11:11 +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 3124036856 for ; Sun, 6 Jun 2021 11:11:10 +0200 (CEST) Received: from localhost ([::1]:43292 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lpooG-0006tE-O8 for larch@yhetil.org; Sun, 06 Jun 2021 05:11:08 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:35136) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lpooA-0006ry-5Z for guix-patches@gnu.org; Sun, 06 Jun 2021 05:11:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:39076) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lpoo9-0006jH-Uh for guix-patches@gnu.org; Sun, 06 Jun 2021 05:11:01 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lpoo9-0005KV-PJ for guix-patches@gnu.org; Sun, 06 Jun 2021 05:11:01 -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: Sun, 06 Jun 2021 09:11:01 +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: Ludovic =?UTF-8?Q?Court=C3=A8s?= Cc: 48667@debbugs.gnu.org, Nicolas Goaziou Received: via spool by 48667-submit@debbugs.gnu.org id=B48667.162297060720422 (code B ref 48667); Sun, 06 Jun 2021 09:11:01 +0000 Received: (at 48667) by debbugs.gnu.org; 6 Jun 2021 09:10:07 +0000 Received: from localhost ([127.0.0.1]:50622 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lponH-0005JJ-5v for submit@debbugs.gnu.org; Sun, 06 Jun 2021 05:10:07 -0400 Received: from h87-96-130-155.cust.a3fiber.se ([87.96.130.155]:50404 helo=mail.yoctocell.xyz) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lponE-0005Ii-7h for 48667@debbugs.gnu.org; Sun, 06 Jun 2021 05:10:06 -0400 From: Xinglu Chen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=yoctocell.xyz; s=mail; t=1622970598; bh=gYEhflAgoxGOgWY7+uPaXvuqCcUKZxOTYGb+GG4YDyw=; h=From:To:Cc:Subject:In-Reply-To:References:Date; b=QJf7HwU6oVWS4kLhgvubrmkPftaxF0C4df202Yxjes2zSHbcujHO8X7ik28Ac8SYR YFRhWdC/E/speo1RaKg7vjpwIVUJmL0fE+O819z0VZq4XG/9sslXiFT/6U5E3f6Yr+ GE9fNMaAPoZu2i+Jm+fkxwMiX4AsaVQ0KUKYEHtU= In-Reply-To: <87zgw4m4xa.fsf_-_@gnu.org> References: <06217762b07f95d2ba2d40277d010647a926df68.1622019402.git.public@yoctocell.xyz> <7a6a9bffa80fdfaa1e14015614cb638ff8cc7441.1622040691.git.public@yoctocell.xyz> <87zgw4m4xa.fsf_-_@gnu.org> Date: Sun, 06 Jun 2021 11:09:54 +0200 Message-ID: <87k0n7740t.fsf@yoctocell.xyz> MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" 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=1622970670; 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: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: dkim-signature; bh=uLS2JjG+u3v4O9xhN0d+FSSFpZaM/8tRrmb/QpQtT5E=; b=eFochkwuKcQLV8gH1NIR3Bl80c176IwGUeelYaHzkJB3MeQZ8u5reBapEvPXInyrvlYiVc jHYrb/GNsnUI9/3H9Yn69lozGyWXfUH/m39vuHBi6v/X3UnYg08/6kKSR67oYJs7Q++HKX tuiqW7BX5pfo+2419SfZdSJHsoNLEiDuI3iKh6Xh0S+wb+w4dLn2Bjap6lzi4ouGUL6iw7 m00uy8sTjE8KOF7Ou062DCODsHMN1HxenkfHGEQwVzum1wibsAZJwB2vTrrZ6H5CIp5kjN yeM6KYAFxP+3CKwhvhy3N/bhzhK0fAexqgHNJEI7pfhGkxkkLaly0n954g5RNg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1622970670; a=rsa-sha256; cv=none; b=lj8f4VHEgl/RLE52oE0H++qaBUCiWCy0zbvYgKMU2CuUH0hxYYIw/mtpwsf7wQ+Sms0Zbz CiKHE6Ejxp3rE9rz9wpJNV5T8n3mfKhpTgORmEwgb2iF+0eIkIO7BooRKmEsLMsmMOCU1F hytmg9WWWd+i9iAXZhpX35cwSldDWzhLMn1ZEmtc5WKMGiIc25UESE5AM7DX9NWhBFG0IR M+4YpgvVMR5LKw/NUcciQSJVa67ZcJFJUks0gyUQoD6BgjhmU0gQ7pYw/nXa8KP3go/AIu owFPdH/2cUtTdJwwSN38TAnacgytL3Yc2Nqa7AJohqqssZXtn+4NcEebozHlWw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=yoctocell.xyz header.s=mail header.b=QJf7HwU6; 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: -3.43 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=yoctocell.xyz header.s=mail header.b=QJf7HwU6; dmarc=fail reason="SPF not aligned (relaxed)" header.from=yoctocell.xyz (policy=none); 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: 3124036856 X-Spam-Score: -3.43 X-Migadu-Scanner: scn0.migadu.com X-TUID: Wdh73FeCroSn --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable On Sat, Jun 05 2021, Ludovic Court=C3=A8s wrote: > Hi Xinglu, > > Xinglu Chen skribis: > >> * doc/guix.texi (package Reference): Describe how packages that lack a r= elease >> or are pinned to an unreleased version should specify the =E2=80=98versi= on=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 wro= ng 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 Gu= idelines=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? Ah, I totally missed the =E2=80=9CVersion Numbers=E2=80=9D section, it look= s like it already all the information I was looking for. Since =E2=80=98hg-version= =E2=80=99 was just added, I will mention it as well. :) --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQJJBAEBCAAzFiEEAVhh4yyK5+SEykIzrPUJmaL7XHkFAmC8kOIVHHB1YmxpY0B5 b2N0b2NlbGwueHl6AAoJEKz1CZmi+1x5a6gP/0xysgVvTA5TMM+lO+FWAv/Ost20 64XJgJRhtmay5ba/hDG1p2VvWYQk2BvwS6dnvQKPs2fG9gAEwxUOqPcCyS3pZkaf nOY3hZyXAvJDppjLBfKhClvcpIDItukHpdTZW5oCxd0y61huL7j2VpPkMBoNvwso 6U2pvW82LvK7/j73N5/KLnVxtHpmCUBXHV4qZHaE4FssjpMru08u6zSmQTdo/ZSU xo2PQJ8APyr/t4cAdfJbKN3GHyjN70ay/TixzWbglCUPTvAMuijHU0Rh937Iq0yv dkxLm+1lv4yaC3OiAnPrPfZXfOqw/fsY6zhDxpHHPPQwvgp4xLpbQ2gZsw22X8m8 ZuIZ1gvCdrQL7BmtS0vHFOVjy4X8FsPiz3CxDC5TU4kkRu+L8sYQRjf/vmVqnUMX A3pxw9F+AUVM077v5o7l+UD6UsfnMnyB5k6E+PARpz/DefVeJURmQVNCUIWVZuR+ MGx0BdipaPe9NVWfmnQhO9FiAjHZ/v9gq8hEHa5Z6RnfNnbP2C6AWxgJd3h8PndP Kqnsxk/scI2GHzBpYVqsvPH37shwuzlvNhR6SxcL/OgZT9WL5SkVd5z7MjQPs9ID 41cmZgaBtT1mv1RFsjS0OGp0+wvFHW5W+pR1qdDJ6+u8IPyYUeoFXUQ0QGlrrlk1 tqH78sLr+Jt1cOW2 =oX+S -----END PGP SIGNATURE----- --=-=-=--