From nobody Tue Feb 10 04:13:09 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) client-ip=205.139.110.120; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-1.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1594732106; cv=none; d=zohomail.com; s=zohoarc; b=BbmOrZv9b5oZhyrszZle4441KSL5kUewOW+T21+4yJclaHu0gl7dUmXje++lKxNHCZudYPlfzw8XYxjJQ5YO0PmGJLC09ZyO7TsCCwSPhXkaOvZhpXI/fDiQudllBXv2xZ+A6ADAtefDgCYYDrRa+RhVIyYC/mZ3iN58KfXlUA4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1594732106; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=ia0y1dqQBRBRnlQpC4nFVeRWDCMn7tpZ7DfuN/46sQs=; b=QxtIQk7oWdAWvChG5KR4nd8SeDrHPjTeHxTVqdTkkW5RWup1d3AScB2NMz9X6QZgNBOn+hOdymRXjBGxptoQWRuScO9dfgDvaSP5ioIWEgt57JnMJ3TMST1gqi1G/KG2DWlTCTpBlBgbLfu4kxvUH6X4UXv3uGPiFeMcswq3LMc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 205.139.110.120 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-1.mimecast.com (us-smtp-delivery-1.mimecast.com [205.139.110.120]) by mx.zohomail.com with SMTPS id 1594732106027562.9841493952472; Tue, 14 Jul 2020 06:08:26 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-218-KHwGCde0P8aG1WZogPFSRw-1; Tue, 14 Jul 2020 09:08:08 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id C1CBB1005268; Tue, 14 Jul 2020 13:07:56 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 9FBD91A837; Tue, 14 Jul 2020 13:07:56 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id 8923F94F09; Tue, 14 Jul 2020 13:07:54 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.phx2.redhat.com [10.5.11.11]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 06ED7qAg022653 for ; Tue, 14 Jul 2020 09:07:52 -0400 Received: by smtp.corp.redhat.com (Postfix) id DFA05724D4; Tue, 14 Jul 2020 13:07:52 +0000 (UTC) Received: from kinshicho.usersys.redhat.com (unknown [10.40.194.169]) by smtp.corp.redhat.com (Postfix) with ESMTPS id EEDDB6FEDF for ; Tue, 14 Jul 2020 13:07:51 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1594732104; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=ia0y1dqQBRBRnlQpC4nFVeRWDCMn7tpZ7DfuN/46sQs=; b=YWOr8XctdkjKhCFk0DjFhdD7pMr6Fj4DwfTZUxDjjsyGtNrJbYWBo9aYTSOo8vCZ8uUumJ aJUbo5b8wKtgS02PsGiGx8jyfP4APisXv28a55c4HNYsFSmm7UuYqGW1qAOSLNu++weUu/ XolKelPSIxbuR9ZSxmvcthRBGmgoBsU= X-MC-Unique: KHwGCde0P8aG1WZogPFSRw-1 From: Andrea Bolognani To: libvir-list@redhat.com Subject: [libvirt PATCH 2/5] docs: platforms: Convert to reStructuredText Date: Tue, 14 Jul 2020 15:07:40 +0200 Message-Id: <20200714130743.515094-3-abologna@redhat.com> In-Reply-To: <20200714130743.515094-1-abologna@redhat.com> References: <20200714130743.515094-1-abologna@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.11 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) Content-Type: text/plain; charset="utf-8" Signed-off-by: Andrea Bolognani --- docs/platforms.html.in | 119 ----------------------------------------- docs/platforms.rst | 100 ++++++++++++++++++++++++++++++++++ 2 files changed, 100 insertions(+), 119 deletions(-) delete mode 100644 docs/platforms.html.in create mode 100644 docs/platforms.rst diff --git a/docs/platforms.html.in b/docs/platforms.html.in deleted file mode 100644 index c50279bffd..0000000000 --- a/docs/platforms.html.in +++ /dev/null @@ -1,119 +0,0 @@ - - - - -

Supported host platforms

- -
    - -

    - Libvirt aims to support building and executing on multiple host OS - platforms, as well as working with multiple hypervisors. This docume= nt - outlines which platforms are targeted for each of these areas. -

    - -

    Build targets

    - -

    - These platforms are used as the basis for deciding - upon the minimum required versions of 3rd party software libvirt dep= ends - 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 platfor= ms - unless they are clearly older vintage than what is described here. -

    - -

    - Note that when considering software versions shipped in distros as - support targets, libvirt considers only the version number, and assu= mes - the features in that distro match the upstream release with the same - version. In other words, 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. -

    - -

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

    - - - - -

    Linux OS

    - -

    - For distributions with frequent, short-lifetime releases, the project - will aim to support all versions that are not end of life by their - respective vendors. For the purposes of identifying supported softwa= re - versions, the project will look at Fedora, Ubuntu, and openSUSE dist= ros. - Other short-lifetime distros will be assumed to ship similar software - versions. -

    - -

    - For distributions with long-lifetime releases, the project will aim = to - support the most recent major version at all times. Support for the - previous major version will be dropped 2 years after the new major - version is released. For the purposes of identifying supported softw= are - versions, the project will look at RHEL, Debian, Ubuntu LTS, and SLES - distros. Other long-lifetime distros will be assumed to ship similar - software versions. -

    - -

    Windows

    - -

    - The project supports building with current versions of the MinGW - toolchain, hosted on Linux. -

    - -

    macOS

    - -

    - The project aims to support the most recent major version - at all times. Support for the previous major version will - be dropped 2 years after the new major version is released. -

    - -

    - Note that to compile libvirt will require extra packages - to be made available on the macOS host. It is recommended - to use HomeBrew since this - is what libvirt CI tests with, however, MacPorts - is an alternative option that is likely to work. -

    - -

    FreeBSD

    - -

    - The project aims to support the most recent major version - at all times. Support for the previous major version will - be dropped 2 years after the new major version is released. -

    - -

    Virtualization platforms

    - -

    - For hypervisor drivers which execute - locally (QEMU, LXC, VZ, libxl, etc), the set of supported operating - system platforms listed above will inform choices as to the minimum - required versions of 3rd party libraries and hypervisor management - APIs. -

    -

    - If a hypervisor is not commonly shipped directly by any distro - listed above, (VMware ESX, HyperV, VZ), the project aims to - support versions up to 5 years, or until the vendor discontinues - support, whichever comes first. -

    - - - diff --git a/docs/platforms.rst b/docs/platforms.rst new file mode 100644 index 0000000000..2845ac40ea --- /dev/null +++ b/docs/platforms.rst @@ -0,0 +1,100 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Supported host platforms +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. contents:: + +Libvirt aims to support building and executing on multiple host OS platfor= ms, +as well as working with multiple hypervisors. This document outlines which +platforms are targeted for each of these areas. + + +Build targets +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +These platforms are used as the basis for deciding upon the minimum requir= ed +versions of 3rd party software libvirt depends on. If a platform is not li= sted +here, it does not imply that libvirt won't work. If an unlisted platform h= as +comparable software versions to a listed platform, there is every expectat= ion +that it will work. Bug reports are welcome for problems encountered on +unlisted platforms unless they are clearly older vintage than what is desc= ribed +here. + +Note that when considering software versions shipped in distros as support +targets, libvirt considers only the version number, and assumes the featur= es in +that distro match the upstream release with the same version. In other wor= ds, +if a distro backports extra features to the software in their distro, libv= irt +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. + +The `Repology`_ site is a useful resource to identify currently shipped +versions of software in various operating systems, though it does not cove= r all +distros listed below. + +* `libvirt on Repology`_ +* `qemu on Repology`_ +* `qemu-kvm on Repology`_ + +Linux OS +-------- + +For distributions with frequent, short-lifetime releases, the project will= aim +to support all versions that are not end of life by their respective vendo= rs. +For the purposes of identifying supported software versions, the project w= ill +look at Fedora, Ubuntu, and openSUSE distros. Other short-lifetime distros +will be assumed to ship similar software versions. + +For distributions with long-lifetime releases, the project will aim to sup= port +the most recent major version at all times. Support for the previous major +version will be dropped 2 years after the new major version is released. F= or +the purposes of identifying supported software versions, the project will = look +at RHEL, Debian, Ubuntu LTS, and SLES distros. Other long-lifetime distros= will +be assumed to ship similar software versions. + +Windows +------- + +The project supports building with current versions of the MinGW toolchain, +hosted on Linux. + +macOS +----- + +The project aims to support the most recent major version at all times. Su= pport +for the previous major version will be dropped 2 years after the new major +version is released. + +Note that to compile libvirt will require extra packages to be made availa= ble +on the macOS host. It is recommended to use `HomeBrew`_ since this is what +libvirt CI tests with, however, `MacPorts`_ is an alternative option that = is +likely to work. + +FreeBSD +------- + +The project aims to support the most recent major version at all times. Su= pport +for the previous major version will be dropped 2 years after the new major +version is released. + + +Virtualization platforms +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +For `hypervisor drivers`_ which execute locally (QEMU, LXC, VZ, libxl, etc= ), +the set of supported operating system platforms listed above will inform +choices as to the minimum required versions of 3rd party libraries and +hypervisor management APIs. + +If a hypervisor is not commonly shipped directly by any distro listed abov= e, +(VMware ESX, HyperV, VZ), the project aims to support versions up to 5 yea= rs, +or until the vendor discontinues support, whichever comes first. + + +.. _HomeBrew: https://brew.sh/ +.. _MacPorts: https://www.macports.org/ +.. _Repology: https://repology.org/ +.. _hypervisor drivers: drivers.html +.. _libvirt on Repology: https://repology.org/metapackage/libvirt/versions +.. _qemu on Repology: https://repology.org/metapackage/qemu/versions +.. _qemu-kvm on Repology: https://repology.org/metapackage/qemu-kvm/versio= ns --=20 2.25.4