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 kNA+C3FYrmB2iwAAgWs5BA (envelope-from ) for ; Wed, 26 May 2021 16:17:21 +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 cFf1BnFYrmCdGwAAB5/wlQ (envelope-from ) for ; Wed, 26 May 2021 14:17:21 +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 7E764A079 for ; Wed, 26 May 2021 16:17:20 +0200 (CEST) Received: from localhost ([::1]:39940 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lluLX-0007gD-8A for larch@yhetil.org; Wed, 26 May 2021 10:17:19 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:35724) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lluDW-0007i3-Ip for guix-patches@gnu.org; Wed, 26 May 2021 10:09:04 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:38102) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lluDW-0005EC-7O for guix-patches@gnu.org; Wed, 26 May 2021 10:09:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lluDW-0005e7-2u for guix-patches@gnu.org; Wed, 26 May 2021 10:09: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 14:09: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: Nicolas Goaziou Cc: 48667@debbugs.gnu.org Received: via spool by 48667-submit@debbugs.gnu.org id=B48667.162203808821642 (code B ref 48667); Wed, 26 May 2021 14:09:02 +0000 Received: (at 48667) by debbugs.gnu.org; 26 May 2021 14:08:08 +0000 Received: from localhost ([127.0.0.1]:49648 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lluCe-0005d0-CL for submit@debbugs.gnu.org; Wed, 26 May 2021 10:08:08 -0400 Received: from h87-96-130-155.cust.a3fiber.se ([87.96.130.155]:54282 helo=mail.yoctocell.xyz) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lluCc-0005by-9z for 48667@debbugs.gnu.org; Wed, 26 May 2021 10:08:07 -0400 From: Xinglu Chen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=yoctocell.xyz; s=mail; t=1622038078; bh=3cnz0xJFpy0nZA5eC/xEEtSU4U6sDv2dZxaZqdB19jw=; h=From:To:Cc:Subject:In-Reply-To:References:Date; b=dQYJ6VjFqZsp8sC7HUe68J/sawLyOtGprLRB1U+gVGLUJi9QN52zlAN2wcFdwpq/Q waPmRoyo4DvkpUF/J9ZTRM5xhF+CPmnvKf7LOaKVGQNgEOjtPFoRcbhxAHeC19DbID NA7RTc0rTh9UmMCzGbkaUZNBeP4hQUWtyBaV4Hm8= In-Reply-To: <87tumphcey.fsf@nicolasgoaziou.fr> References: <06217762b07f95d2ba2d40277d010647a926df68.1622019402.git.public@yoctocell.xyz> <87tumphcey.fsf@nicolasgoaziou.fr> Date: Wed, 26 May 2021 16:07:55 +0200 Message-ID: <874kepy4ec.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=1622038640; 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=HOIQPQlY5/yUm9ZZAdHzVhgRFgTqqvOPoLbitHcV+uI=; b=SlDyeVfkyOE8VwyDd4VdB/kItvqHzT/tE5N2/24/CzTn+c2CpP1ZS9W0iov6IyNfKeVj3o 0i4exSU5L/ZdfP14fdm0ZOkOEQM47YI4Q66kxX0kkq0dKPrLGEZFmEO57W0kdXKGh/rVXM GkUJpzhtFvVF8OAwcX7XRTk0tl2BXQ87hZyoPjKaybVSysqm6o0FuIPXWbBraPMaIcwOxb /k6ZEHItkZsOrq4+0k0KXwqILYhk29WipObDOuxygx4E1b+g52c18WqU5IwbFK1zAUmNQ2 MA3BIoIsgGXwLM78XHB3y22LBQn/a8c1ZDNjz9enMDVva1fZhfpmjMUXpYP2Mw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1622038640; a=rsa-sha256; cv=none; b=cdmU8mmKF2EMg0pNBuGU4nQqRNEK4NO7xE9S6y0EA7vdEENj5blL/FkkZXIz/FSBwQiE14 WYbrlMJX+u2RIBap8Zsz5yjB8K3WPF/y+O4cwDiEQUB3jGgdk4Kr5Eiq2Jr/13JRas+LZz uG0UCPC2RMFwlmomfft4zamJmdUWPwaWImN75jegBDSS6ilczBGY6YMPCBSIBgp/8Dx1yo a8fXcA4yQNuPkohij/MT+XkF2enferaBAY4WQkIkLqrhCaT9jtZMWtswpPjh28+Z7xwpeU B8biywaBL8//QsywMXhofA7haDJ37K5tO6WZo0ONfAR2e+OtHCl3FheKToCm2w== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=yoctocell.xyz header.s=mail header.b=dQYJ6VjF; 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-Spam-Score: -3.43 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=yoctocell.xyz header.s=mail header.b=dQYJ6VjF; 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: 7E764A079 X-Spam-Score: -3.43 X-Migadu-Scanner: scn1.migadu.com X-TUID: RtPcuU65X9wQ --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable On Wed, May 26 2021, Nicolas Goaziou wrote: > Hello, > > Xinglu Chen writes: > >> * 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. > > Thanks.=20 > > I don't know if all should be included in the manual (though I think > the `git-version' function definitely should), but I'll comment it a bit > anyway. > >> @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 ? > > @samp{@var{VERSION}-@var{REVISION}.@var{COMMIT}} ... @var{VERSION}... > > I think you should drop the "version 0" case altogether. I don't think > enforcing "0" or "0.0.0" does matter, and it adds noise to the > explanations. Makes sense, users can probably that out on their own. >> +@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. > > @var{REVISION} > > I think you need to explain why bumping revision is needed. > > Also, this is all specific to hash-based repositories. For example, SVN > uses monotonic revisions already, so none of the above applies to such > packages. I am not familiar with SVN, but I will look into it. >> @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. > > @var{COMMIT} > >> +@example >> +(git-version "0.0.0" "0" "93818c936ee7e2f1ba1b315578bde363a7d43d05") >> +@result{} "0.0.0-0.93818c9" >> +@end example >> +@end deffn > > Here too, I think the special "0.0.0" case is misleading. > > Maybe @lisp is more appropriate than @example. Good point. Thanks for the review! --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQJJBAEBCAAzFiEEAVhh4yyK5+SEykIzrPUJmaL7XHkFAmCuVjsVHHB1YmxpY0B5 b2N0b2NlbGwueHl6AAoJEKz1CZmi+1x5eYEP/2UKukDv1Nm9eUGuwdtU5Svs2ZPn f+K7LFpzuijRzCbPPxKrf0vy6QBhLHJDjR6kuUkfgsApj4Bhy5coDxTIvM31EN4S aoo8rMeIyQx6mtNjxBD5stRt7ABVmcnavVGS0hb6Jbkvddwkj5tB6k1cadnYf3TR QKkl+CSCGS2my7b4l9+2tFSw+AAkkTLJz9pYOjt63fZIlOH/R6lJZCXRfCuPBXrE FxiCoCSFnUmb0YRBTb/SKDolBM+DreTP4cUyU/ksMCPjC01vX6rEH2EU5RBMjZ5I lOZWrraLD2NCRR3s26G2Mke0X66n7usfOHG5bHtOp5WQY7vFaduxmMk0Optn21Ar HgZRdXaHtqQmdDZu00lP4+tseip+F1HQ7AeE7Aj3uh7ivXg79CexZ4J2dpiZ0bcc J+W8+74H10zboqnb07rc79yb4p/k2NU9FoSsL4S76ag+Rwhad8+2mSU0GDlZ83uG niJ2JkAk7XT5onRtvxLbs0Ns8KbprhCKqMZNj7gEdCakkPkQrA6L3qhPtBLQL8zo IcT90c6I9c9aI5K896hRyUBwAnRHkbNln8p5xEdnyxmCxc/amGn80ioStsoBaikh Ds0W/G6qFIkMyDu5430xGWTYNUUkb+0K4DJx5gN4KocjQng6dK2nNTCDhayk1ect 3puTS1I9r3YF0n02 =v8xw -----END PGP SIGNATURE----- --=-=-=--