[libvirt] [PATCH v2] docs: add page describing goals for host platform version support

Thu Apr 5 11:12:21 UTC 2018

On Thu, Apr 05, 2018 at 12:56:57PM +0200, Pavel Hrdina wrote:
> On Thu, Apr 05, 2018 at 11:05:04AM +0100, Daniel P. Berrangé wrote:
> > Described how we decide which host platforms to support for libvirt,
> > which in turn makes it easier to decide when a platform / software
> > version can be dropped.
> > 
> > Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
> > ---
> >  docs/index.html.in     |   2 +-
> >  docs/platforms.html.in | 105 +++++++++++++++++++++++++++++++++++++++++++++++++
> >  2 files changed, 106 insertions(+), 1 deletion(-)
> >  create mode 100644 docs/platforms.html.in
> > 
> > diff --git a/docs/index.html.in b/docs/index.html.in
> > index 1b3a7a3db6..4783c39e3c 100644
> > --- a/docs/index.html.in
> > +++ b/docs/index.html.in
> > @@ -28,7 +28,7 @@
> >          The libvirt project:
> >        </p>
> >        <ul>
> > -        <li>is a toolkit to manage virtualization hosts</li>
> > +        <li>is a toolkit to manage <a href="platforms.html.in">virtualization platforms</a></li>
> >          <li>is accessible from C, Python, Perl, Java and more</li>
> >          <li>is licensed under open source licenses</li>
> >          <li>supports <a href="drvqemu.html">KVM</a>,
> > diff --git a/docs/platforms.html.in b/docs/platforms.html.in
> > new file mode 100644
> > index 0000000000..776e930e78
> > --- /dev/null
> > +++ b/docs/platforms.html.in
> > @@ -0,0 +1,105 @@
> > +<?xml version="1.0" encoding="UTF-8"?>
> > +<!DOCTYPE html>
> > +<html xmlns="http://www.w3.org/1999/xhtml">
> > +  <body>
> > +    <h1>Supported host platforms</h1>
> > +
> > +    <ul id="toc"></ul>
> > +
> > +    <h2>Build targets</h2>
> > +
> > +    <p>
> > +      Libvirt drivers aim to support building and executing on multiple
> > +      host OS platforms. This document outlines which platforms are the
> > +      major build targets. These platforms are used as the basis for deciding
> > +      upon the minimum required versions of 3rd party software libvirt depends
> > +      on. If a platform is not listed here, it does not imply that libvirt
> > +      won't work. If an unlisted platform has comparable software versions
> > +      to a listed platform, there is every expectation that it will work.
> > +      Bug reports are welcome for problems encountered on unlisted platforms
> > +      unless they are clearly older vintage that what is described here.
> > +    </p>
> > +
> > +    <p>
> > +      Note that when considering software versions shipped in distros as
> > +      support targets, libvirt considers only the version number, and assumes
> > +      the features in that distro match the upstream release with the same
> > +      version. IOW, if a distro backports extra features to the software in
> > +      their distro, libvirt upstream code will not add explicit support for
> > +      those backports, unless the feature is auto-detectable in a manner that
> > +      works for the upstream releases too.
> > +    </p>
> > +
> > +    <p>
> > +      The Repology site is a useful resource to identify currently shipped
> > +      versions of software in various operating systems, though it does not
> > +      cover all distros listed below.
> > +    </p>
> > +
> > +    <ul>
> > +      <li><a href="https://repology.org/metapackage/libvirt/versions">libvirt</a></li>
> > +      <li><a href="https://repology.org/metapackage/qemu/versions">qemu</a></li>
> 
> Maybe we should also list the "qemu-kvm" package since RHEL/CentOS uses
> that name.

Oh yes, it never occurred to me to check if that name existed. Will add
it.

> Reviewed-by: Pavel Hrdina <phrdina at redhat.com>

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 :|