Put version numbering details in its own doc
PATCH 1/1 Put version numbering details in its own doc
Instead of burying the version numbering details under "Download QEMU" page, place it in its own document. And highlight its presence in the website footer.
While at it, add a concrete example of the version numbering scheme.
--- _includes/footer.html | 1 + download.html | 23 ----------------------- version-numbering.md | 26 ++++++++++++++++++++++++++ 3 files changed, 27 insertions(+), 23 deletions(-) create mode 100644 version-numbering.md
_includes/footer.html +1 -0
@@ -17,6 +17,7 @@ <li><a href="https://qemu.weilnetz.de/qemu-doc.html">Manual</a></li> <li><a href="https://wiki.qemu.org/Category:Developer_documentation">Developer docs</a></li> <li><a href="https://wiki.qemu.org/">Wiki</a></li> + <li><a href="/version-numbering">Version numbering</a></li> </ul> <ul class="style"> <li><a href="https://planet.virt-tools.org/">virt tools planet</a></li>
download.html +0 -23
@@ -40,29 +40,6 @@ permalink: /download/ </article> </div> -<h2>Version numbering</h2> -<div> - <p> - Since version 3.0.0, QEMU uses a time based version numbering scheme: - </p> -<dl> -<dt>major</dt> -<dd>incremented by 1 for the first release of the year</dd> -<dt>minor</dt> -<dd>reset to 0 with every major increment, otherwise incremented by 1 for each release from git master</dd> -<dt>micro</dt> -<dd>always 0 for releases from git master, incremented by 1 for each stable branch release</dd> -</dl> - <p> - The implication of this is that changes in major version number - <strong>do not</strong> have any bearing on the scope of changes - included in the release. Non-backward compatible changes may be made - in any master branch release, provided they have followed the - <a href="https://qemu.weilnetz.de/doc/qemu-doc.html#Deprecated-features">deprecation policy</a> - which calls for warnings to be emitted for a minimum of two releases - prior to the change. - </p> -</div> <script> function animateOnClick(jqThis, slide) { $('.horiz-menu li').removeClass('active');
version-numbering.md new file +26 -0
@@ -0,0 +1,26 @@ +--- +title: QEMU version numbering +permalink: /version-numbering/ +--- + +Since version 3.0.0, QEMU uses a time based version numbering scheme: + + - major: incremented by 1 for the first release of the year + + - minor: reset to 0 with every major increment, otherwise + incremented by 1 for each release from git master + + - micro: always 0 for releases from git master, incremented by 1 for + each stable branch release + +The implication of this is that changes in major version number *do not* +have any bearing on the scope of changes included in the release. +Non-backward compatible changes may be made in any master branch +release, provided they have followed the [deprecation +policy](https://qemu.weilnetz.de/doc/qemu-doc.html#Deprecated-features) +which calls for warnings to be emitted for a minimum of two releases +prior to the change. + +Example number scheme: in the year 2019, there will be 4.0.0, 4.1.0 and +4.2.0 releases; following that, 5.0.0, 5.1.0, 5.2.0 releases in 2020, +and so on.
Signature · 1 line
2.17.2
Quoted 3 lines · Kashyap Chamarthy
Instead of burying the version numbering details under "Download QEMU" page, place it in its own document. And highlight its presence in the website footer.
I'm not sure I agree with saying it is "buried" on the download page.
It is pretty clearly visible, and it is relevant information at the time you are downloading. If anything, moving it off into a separate page /is/ burying it IMHO, as now its not visible at time of download
Quoted 78 lines
While at it, add a concrete example of the version numbering scheme.
Signed-off-by Kashyap Chamarthy <[email protected]>--- _includes/footer.html | 1 + download.html | 23 ----------------------- version-numbering.md | 26 ++++++++++++++++++++++++++ 3 files changed, 27 insertions(+), 23 deletions(-) create mode 100644 version-numbering.md_includes/footer.html +1
-0@@ -17,6 +17,7 @@ <li><a href="https://qemu.weilnetz.de/qemu-doc.html">Manual</a></li> <li><a href="https://wiki.qemu.org/Category:Developer_documentation">Developer docs</a></li> <li><a href="https://wiki.qemu.org/">Wiki</a></li> + <li><a href="/version-numbering">Version numbering</a></li> </ul> <ul class="style"> <li><a href="https://planet.virt-tools.org/">virt tools planet</a></li>download.html +0
-23@@ -40,29 +40,6 @@ permalink: /download/ </article> </div> -<h2>Version numbering</h2> -<div> - <p> - Since version 3.0.0, QEMU uses a time based version numbering scheme: - </p> -<dl> -<dt>major</dt> -<dd>incremented by 1 for the first release of the year</dd> -<dt>minor</dt> -<dd>reset to 0 with every major increment, otherwise incremented by 1 for each release from git master</dd> -<dt>micro</dt> -<dd>always 0 for releases from git master, incremented by 1 for each stable branch release</dd> -</dl> - <p> - The implication of this is that changes in major version number - <strong>do not</strong> have any bearing on the scope of changes - included in the release. Non-backward compatible changes may be made - in any master branch release, provided they have followed the - <a href="https://qemu.weilnetz.de/doc/qemu-doc.html#Deprecated-features">deprecation policy</a> - which calls for warnings to be emitted for a minimum of two releases - prior to the change. - </p> -</div> <script> function animateOnClick(jqThis, slide) { $('.horiz-menu li').removeClass('active');version-numbering.md new file +16
-0@@ -0,0 +1,26 @@ +--- +title: QEMU version numbering +permalink: /version-numbering/ +--- + +Since version 3.0.0, QEMU uses a time based version numbering scheme: + + - major: incremented by 1 for the first release of the year + + - minor: reset to 0 with every major increment, otherwise + incremented by 1 for each release from git master + + - micro: always 0 for releases from git master, incremented by 1 for + each stable branch release + +The implication of this is that changes in major version number *do not*
version-numbering.md line 26
Quoted 10 lines
version-numbering.md new file +10
-0+have any bearing on the scope of changes included in the release. +Non-backward compatible changes may be made in any master branch +release, provided they have followed the [deprecation +policy](https://qemu.weilnetz.de/doc/qemu-doc.html#Deprecated-features) +which calls for warnings to be emitted for a minimum of two releases +prior to the change. + +Example number scheme: in the year 2019, there will be 4.0.0, 4.1.0 and +4.2.0 releases; following that, 5.0.0, 5.1.0, 5.2.0 releases in 2020, +and so on.
Regards,
Daniel
Signature · 3 lines
|: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Quoted 6 lines · Daniel P. Berrangé
Quoted 3 lines · Kashyap Chamarthy
Instead of burying the version numbering details under "Download QEMU" page, place it in its own document. And highlight its presence in the website footer.
I'm not sure I agree with saying it is "buried" on the download page.
True. I exaggerated a bit there; sorry.
Quoted 3 lines
It is pretty clearly visible, and it is relevant information at the time you are downloading. If anything, moving it off into a separate page /is/ burying it IMHO, as now its not visible at time of download
Your argument is valid, and at first I actually did think the way describe. Then I remembered how I recently was trying to look up the versioning details of QEMU and not finding it. Not sure what terms I used at that time.
Right now, typing "qemu version numbering" (*without* quotes) does show the "Download QEMU" page as third result. And the first result points to this page:
https://www.qemu.org/2018/08/15/qemu-3-0-0/
Which does have:
A note from the maintainer: Why 3.0? Well, we felt that our version numbers were getting a bit unwieldy, and since this year is QEMU’s 15th birthday it seemed like a good excuse to roll over the major digit. Going forward we plan to increment the major version once a year, for the first release of the year. Don’t read too much into
it: it doesn’t imply a drastic compatibility break.
So, I tend to agree with what you said, so feel free to disregard this change, then. :-)
[...]
Signature · 1 line
/kashyap