[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Version numbers for VCS snapshots
From: |
Ludovic Courtès |
Subject: |
Re: Version numbers for VCS snapshots |
Date: |
Sat, 23 Jan 2016 23:00:19 +0100 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux) |
Ricardo Wurmus <address@hidden> skribis:
> Ludovic Courtès <address@hidden> writes:
>
>> +
>> +It is a good idea to strip commit identifiers to, say, 7 digits so that
>> +they do not become aesthetically disturbing (assuming aesthetics have a
>> +role to play here.) It is best to use the full commit identifiers in
>> address@hidden, though, to avoid ambiguities.
>> +
>
> I would probably find this a little confusing if I didn’t already know
> what you meant. Where should commit identifiers be stripped? Are there
> more places than just the ‘version’ field? Could we name the ‘version’
> field as an example?
>
> Is it only aesthetics or also a matter of keeping shebangs shorter (in
> case the output provides an interpreter that could end up in a shebang
> line). The version is usually part of the output name, so maybe it
> would make sense to mention the ‘version’ field explicitly.
You’re right on both points.
How about this variant?
diff --git a/doc/guix.texi b/doc/guix.texi
index 0a67652..a8b9366 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -10130,6 +10130,38 @@ If we also wanted GTK+ 3.8.2, this would be packaged as
...))
@end example
address@hidden version number, for VCS snapshots
+Occasionally, we package snapshots of upstream's version control system
+(VCS) instead of formal releases. This should remain exceptional,
+because it is up to upstream developers to clarify what the stable
+release is. Yet, it is sometimes necessary. So, what should we put in
+the @code{version} field?
+
+Clearly, we need to make the commit identifier of the VCS snapshot
+visible in the version string, but we also need to make sure that the
+version string is monotonically increasing so that @command{guix package
+--upgrade} can determine which version is newer. Since commit
+identifiers, notably with Git, are not monotonically increasing, we add
+a revision number that we increase each time we upgrade to a newer
+snapshot. The resulting version string looks like this:
+
address@hidden
+2.0.11-3.cabba9e
+ ^ ^ ^
+ | | `-- upstream commit ID
+ | |
+ | `--- Guix package revision
+ |
+latest upstream version
address@hidden example
+
+It is a good idea to strip commit identifiers in the @code{version}
+field to, say, 7 digits. It avoids an aesthetic annoyance (assuming
+aesthetics have a role to play here) as well as problems related to OS
+limits such as the maximum shebang length (127 bytes for the Linux
+kernel.) It is best to use the full commit identifiers in
address@hidden, though, to avoid ambiguities.
+
@node Synopses and Descriptions
@subsection Synopses and Descriptions
Thanks!
Ludo’.
- Re: New CLI syntax for package version, (continued)
- Re: New CLI syntax for package version, Ricardo Wurmus, 2016/01/12
- Version numbers for VCS snapshots, Ludovic Courtès, 2016/01/12
- Re: Version numbers for VCS snapshots, Ben Woodcroft, 2016/01/20
- Re: Version numbers for VCS snapshots, Leo Famulari, 2016/01/21
- Re: Version numbers for VCS snapshots, Ricardo Wurmus, 2016/01/21
- Re: Version numbers for VCS snapshots, Leo Famulari, 2016/01/21
- Re: Version numbers for VCS snapshots, Ludovic Courtès, 2016/01/21
- Re: Version numbers for VCS snapshots, Ricardo Wurmus, 2016/01/21
- Re: Version numbers for VCS snapshots, Ludovic Courtès, 2016/01/21
- Re: Version numbers for VCS snapshots, Ricardo Wurmus, 2016/01/21
- Re: Version numbers for VCS snapshots,
Ludovic Courtès <=
- Re: Version numbers for VCS snapshots, Ricardo Wurmus, 2016/01/23
- Re: Version numbers for VCS snapshots, Ludovic Courtès, 2016/01/24
- Re: Version numbers for VCS snapshots, Eric Bavier, 2016/01/21
- Re: Version numbers for VCS snapshots, Jookia, 2016/01/21
- Re: Version numbers for VCS snapshots, Andy Wingo, 2016/01/22
- Re: Version numbers for VCS snapshots, Ricardo Wurmus, 2016/01/22
- Re: Version numbers for VCS snapshots, Ludovic Courtès, 2016/01/23
Re: New CLI syntax for package version, Federico Beffa, 2016/01/09