From: "Ludovic Courtès" <ludo@gnu.org>
To: Xinglu Chen <public@yoctocell.xyz>
Cc: 48667@debbugs.gnu.org, Nicolas Goaziou <mail@nicolasgoaziou.fr>
Subject: [bug#48667] [PATCH] doc: Expound on how to specify the version of a package.
Date: Sat, 05 Jun 2021 22:29:05 +0200 [thread overview]
Message-ID: <87zgw4m4xa.fsf_-_@gnu.org> (raw)
In-Reply-To: <7a6a9bffa80fdfaa1e14015614cb638ff8cc7441.1622040691.git.public@yoctocell.xyz> (Xinglu Chen's message of "Wed, 26 May 2021 16:57:57 +0200")
Hi Xinglu,
Xinglu Chen <public@yoctocell.xyz> skribis:
> * 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.
[...]
> @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 “package Reference” is the wrong place for
it: it’s the reference, whereas the text above is a guideline.
The “Version Numbers” section under “Packaging Guidelines” already
touches this topic. Perhaps we need to expand it and/or link to it from
“package Reference”, like:
@item @code{version}
The version of the package, as a string. @xref{Version Numbers}, for
guidelines.
The ‘git-version’ procedure could be documented in “Version Numbers”
too.
WDYT?
Thanks,
Ludo’.
next prev parent reply other threads:[~2021-06-05 20:30 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-26 9:00 [bug#48667] [PATCH] doc: Expound on how to specify the version of a package Xinglu Chen
2021-05-26 13:06 ` Nicolas Goaziou
2021-05-26 14:07 ` Xinglu Chen
2021-05-26 14:57 ` Xinglu Chen
2021-06-05 20:29 ` Ludovic Courtès [this message]
2021-06-06 9:09 ` Xinglu Chen
2021-06-06 9:19 ` [bug#48667] [PATCH] doc: Add reference for ‘git-ver Xinglu Chen
2021-06-06 9:48 ` Maxime Devos
2021-06-06 10:33 ` Xinglu Chen
2021-06-06 10:37 ` [bug#48667] [PATCH v2] doc: Add refernece for ‘git-version’ and ‘hg-version’ Xinglu Chen
2021-06-06 12:36 ` bug#48667: " Ludovic Courtès
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87zgw4m4xa.fsf_-_@gnu.org \
--to=ludo@gnu.org \
--cc=48667@debbugs.gnu.org \
--cc=mail@nicolasgoaziou.fr \
--cc=public@yoctocell.xyz \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.