Re: [Qemu-devel] [PATCH] [qemu-web] Put version numbering details in its own doc

[Daniel P . Berrangé]

On Mon, Feb 11, 2019 at 05:20:52PM +0100, Kashyap Chamarthy wrote:
> 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

> While at it, add a concrete example of the version numbering scheme.
> 
> Signed-off-by: Kashyap Chamarthy <address@hidden>
> ---
>  _includes/footer.html |  1 +
>  download.html         | 23 -----------------------
>  version-numbering.md  | 26 ++++++++++++++++++++++++++
>  3 files changed, 27 insertions(+), 23 deletions(-)
>  create mode 100644 version-numbering.md
> 
> diff --git a/_includes/footer.html b/_includes/footer.html
> index 
> 1669ef766cc18b0df3e27418038f9bf851b74c8a..0fb85feb564e3b23bc4ab78eb05359264d13bfa5
>  100644
> --- a/_includes/footer.html
> +++ b/_includes/footer.html
> @@ -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>
> diff --git a/download.html b/download.html
> index 
> 3c2df66ff6757bba1246b5f0873b287fca600f11..e4c8bb5792aa6e6f7038a9fd2bdab3c432daa6ab
>  100644
> --- a/download.html
> +++ b/download.html
> @@ -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');
> diff --git a/version-numbering.md b/version-numbering.md
> new file mode 100644
> index 
> 0000000000000000000000000000000000000000..9ace69128f76d7eb5b71e062ccdcb3ffd768ccc6
> --- /dev/null
> +++ b/version-numbering.md
> @@ -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.


Regards,
Daniel
-- 
|: 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 :|