After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 757736 - Programming guidelines: problems in the versioning page
Programming guidelines: problems in the versioning page
Status: RESOLVED FIXED
Product: gnome-devel-docs
Classification: Applications
Component: programming-guidelines
3.18.x
Other All
: Normal normal
: ---
Assigned To: GNOME Devel docs: Programming Guidelines maintainer(s)
gnome-devel-docs maintainers
Depends on:
Blocks:
 
 
Reported: 2015-11-07 14:57 UTC by Sébastien Wilmet
Modified: 2015-11-13 09:29 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
programming-guidelines: micro package version for apps too (5.93 KB, patch)
2015-11-08 16:36 UTC, Sébastien Wilmet
committed Details | Review
programming-guidelines: odd/even versions for stable/unstable releases (2.58 KB, patch)
2015-11-08 16:36 UTC, Sébastien Wilmet
none Details | Review
programming-guidelines: odd/even versions for stable/unstable releases (2.66 KB, patch)
2015-11-11 10:13 UTC, Sébastien Wilmet
committed Details | Review
programming-guidelines: typography fixes (4.26 KB, patch)
2015-11-11 10:14 UTC, Sébastien Wilmet
committed Details | Review
programming-guidelines: add some missing markup in documentation.page (1.55 KB, patch)
2015-11-11 10:14 UTC, Sébastien Wilmet
committed Details | Review

Description Sébastien Wilmet 2015-11-07 14:57:53 UTC
The application versioning guideline is wrong:
https://developer.gnome.org/programming-guidelines/unstable/versioning.html.en#application-versioning

AFAIK all GNOME applications have a micro version for bug fixes and translation updates, not "major.minor".

Another thing worth explaining is the odd/even minor version convention, and the 6-months release schedule.
Comment 1 Sébastien Wilmet 2015-11-07 15:00:11 UTC
(before writing patches I prefer to have your opinion)
Comment 2 Philip Withnall 2015-11-07 15:08:37 UTC
(In reply to Sébastien Wilmet from comment #0)
> The application versioning guideline is wrong:
> https://developer.gnome.org/programming-guidelines/unstable/versioning.html.
> en#application-versioning
> 
> AFAIK all GNOME applications have a micro version for bug fixes and
> translation updates, not "major.minor".

Yes, include that. These guidelines were (apparently, badly, sorry) adapted from another project which doesn't use micro versions.

> Another thing worth explaining is the odd/even minor version convention, and
> the 6-months release schedule.

I would mention the odd/even version convention as one convention which is followed by most (but not all) GNOME modules. I don't think the release schedule is relevant here in an explanation about versioning systems.
Comment 3 Sébastien Wilmet 2015-11-08 16:36:03 UTC
Created attachment 315083 [details] [review]
programming-guidelines: micro package version for apps too

Restructure the sections. Since the package versioning is the same for
libraries and apps, have the "Package Versioning" section in common. And
have a "Libtool Versioning" section.
Comment 4 Sébastien Wilmet 2015-11-08 16:36:09 UTC
Created attachment 315084 [details] [review]
programming-guidelines: odd/even versions for stable/unstable releases
Comment 5 Philip Withnall 2015-11-09 19:23:11 UTC
Review of attachment 315083 [details] [review]:

::: programming-guidelines/C/versioning.page
@@ +64,3 @@
+      The package version number is that passed to
+      <code>AC_INIT()</code>, and the one which is typically known as the
+      project’s version number. For example, the Debian package for a library

s/'/’/ (and in other places).
Comment 6 Philip Withnall 2015-11-09 19:24:45 UTC
Review of attachment 315084 [details] [review]:

::: programming-guidelines/C/versioning.page
@@ +160,3 @@
+      new features, only translation updates and bug fixes.  On the other hand,
+      a new micro <em>unstable</em> version (e.g. 3.19.1 → 3.19.2) can add new
+      features.

Unstable micro releases can also add API, or change or remove API which was added in a previous micro release in that minor series.
Comment 7 Sébastien Wilmet 2015-11-11 10:13:23 UTC
Thanks for the review. The first patch doesn't need to be updated since it doesn't contain single quotes ', only ’.
Comment 8 Sébastien Wilmet 2015-11-11 10:13:57 UTC
Created attachment 315238 [details] [review]
programming-guidelines: odd/even versions for stable/unstable releases
Comment 9 Sébastien Wilmet 2015-11-11 10:14:02 UTC
Created attachment 315239 [details] [review]
programming-guidelines: typography fixes
Comment 10 Sébastien Wilmet 2015-11-11 10:14:07 UTC
Created attachment 315240 [details] [review]
programming-guidelines: add some missing markup in documentation.page

While I'm at it.
Comment 11 Philip Withnall 2015-11-13 00:33:40 UTC
(In reply to Sébastien Wilmet from comment #7)
> Thanks for the review. The first patch doesn't need to be updated since it
> doesn't contain single quotes ', only ’.

Huh, looks like Splinter helpfully reformatted them as straight quotes, or used a font which does. My apologies.
Comment 12 Philip Withnall 2015-11-13 00:35:57 UTC
Review of attachment 315238 [details] [review]:

++
Comment 13 Philip Withnall 2015-11-13 00:38:28 UTC
Review of attachment 315239 [details] [review]:

++
Comment 14 Philip Withnall 2015-11-13 00:39:08 UTC
Review of attachment 315240 [details] [review]:

Super!
Comment 15 Sébastien Wilmet 2015-11-13 09:28:45 UTC
Attachment 315083 [details] pushed as 3670de8 - programming-guidelines: micro package version for apps too
Attachment 315238 [details] pushed as fefa778 - programming-guidelines: odd/even versions for stable/unstable releases
Attachment 315239 [details] pushed as 247bad8 - programming-guidelines: typography fixes
Attachment 315240 [details] pushed as 4d271c2 - programming-guidelines: add some missing markup in documentation.page