From 11850158bdae1572d587b10ea8cb7c12d4f61527 Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Thu, 10 Mar 2022 15:32:04 +0100 Subject: [PATCH] docs: Convert 'downloads' page to rST MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit The table was manually converted to a set of 'list-table'-s for better experience of viewing the text. Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- docs/downloads.html.in | 661 ----------------------------------------- docs/downloads.rst | 418 ++++++++++++++++++++++++++ docs/meson.build | 2 +- 3 files changed, 419 insertions(+), 662 deletions(-) delete mode 100644 docs/downloads.html.in create mode 100644 docs/downloads.rst diff --git a/docs/downloads.html.in b/docs/downloads.html.in deleted file mode 100644 index 40724cce22..0000000000 --- a/docs/downloads.html.in +++ /dev/null @@ -1,661 +0,0 @@ - - - - -

Downloads

- -
    - -

    Project modules

    - -

    - The libvirt project maintains a number of inter-related modules beyond - the core C library/daemon. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ModuleReleasesGIT RepoBug TrackerGIT MirrorsResources
    libvirt - libvirt - - gitlab - - issues - - libvirt - github - - api ref - changes -
    Language bindings
    C# - libvirt - - gitlab - - issues - - libvirt - github -
    Go - libvirt - - gitlab - - issues - - libvirt - github - - api ref -
    Java - libvirt - - gitlab - - issues - - libvirt - github -
    OCaml - libvirt - - gitlab - - issues - - libvirt - github -
    Perl (Sys::Virt) - cpan - - gitlab - - issues - - libvirt - github - - api ref - changes -
    PHP - libvirt - - gitlab - - issues - - libvirt - github -
    Python - libvirt - pypi - - gitlab - - issues - - libvirt - github -
    Ruby - libvirt - - gitlab - - issues - - libvirt - github -
    Rust - crates.io - - gitlab - - issues - - libvirt - github - - api ref -
    Integration modules
    GLib / GConfig / GObject - libvirt - - gitlab - - issues - - libvirt - github -
    Go XML - libvirt - - gitlab - - issues - - libvirt - github - - api ref -
    D-Bus - libvirt - - gitlab - - issues - - libvirt - github -
    Console Proxy - libvirt - - gitlab - - issues - - libvirt - github -
    CIM provider - libvirt - - gitlab - - issues - - libvirt - github -
    CIM utils - libvirt - - gitlab - - issues - - libvirt - github -
    SNMP - libvirt - - gitlab - - issues - - libvirt - github -
    Application Sandbox - libvirt - - gitlab - - issues - - libvirt - github -
    Testing
    TCK - libvirt - - gitlab - - issues - - libvirt - github -
    Test API - gitlab - - issues - - libvirt - github -
    Continuous Integration Config - gitlab - - issues - - libvirt - github -
    CIM Test - gitlab - - issues - - libvirt - github -
    Documentation
    Publican Brand - gitlab - - issues - - libvirt - github -
    App Development Guide - gitlab - - issues - - libvirt - github -
    App Development Guide Python - gitlab - - issues - - libvirt - github -
    virsh Command Reference - gitlab - - issues - - libvirt - github -
    - -

    Primary download site

    - -

    - Most modules have releases made available for download on the project - site via HTTPS. Some modules are instead made available at alternative - locations, for example, the Perl binding is made available only on CPAN. -

    - - - -

    Primary release schedule

    - -

    - The core libvirt module follows a time based plan, with releases made - once a month on the 1st of each month give or take a few days. The only - exception is at the start of the year where there are two 6 weeks gaps - (first release in the middle of Jan, then skip the Feb release), giving - a total of 11 releases a year. The Python and Perl modules will aim to - release at the same time as the core libvirt module. Other modules have - independent ad-hoc releases with no fixed time schedule. -

    - -

    Release numbering

    - -

    - Since libvirt 2.0.0, a time based version numbering rule - is applied to the core library releases. As such, the changes - in version number have do not have any implications with respect - to the scope of features or bugfixes included, the stability of - the code, or the API / ABI compatibility (libvirt API / ABI is - guaranteed stable forever). The rules applied for changing the - libvirt version number are: -

    - -
    -
    major
    -
    incremented by 1 for the first release of the year (the - Jan 15th release)
    -
    minor
    -
    reset to 0 with every major increment, otherwise incremented by 1 - for each monthly release from git master
    -
    micro
    -
    always 0 for releases from git master, incremented by 1 - for each stable maintenance release
    -
    - -

    - Prior to 2.0.0, the major/minor numbers were incremented - fairly arbitrarily, and maintenance releases appended a - fourth digit. The language bindings will aim to use the - same version number as the most recent core library API - they support. The other modules have their own distinct - release numbering sequence, though they generally aim - to follow the above rules for incrementing major/minor/micro - digits. -

    - -

    Maintenance releases

    -

    - In the git repository are several stable maintenance branches - for the core library, matching the - pattern vmajor.minor-maint; - these branches are forked off the corresponding - vmajor.minor.0 formal - release, and may have further releases of the - form vmajor.minor.micro. - These maintenance branches should only contain bug fixes, and no - new features, backported from the master branch, and are - supported as long as at least one downstream distribution - expresses interest in a given branch. These maintenance - branches are considered during CVE analysis. In contrast - to the primary releases which are made once a month, there - is no formal schedule for the maintenance releases, which - are made whenever there is a need to make available key - bugfixes to downstream consumers. The language bindings - and other modules generally do not provide stable branch - releases. -

    - -

    - For more details about contents of maintenance releases, see - the - wiki page. -

    - -

    GIT source repository

    - -

    - All modules maintained by the libvirt project have their primary - source available in the project GIT server. - Each module can be cloned anonymously using: -

    - - 
    -git clone https://libvirt.org/git/[module name].git
    - -

    - The git:// protocol is also available if desired, but - https:// is encouraged, since it is more reliable when - faced with strict firewalls. -

    - - 
    -git clone git://libvirt.org/[module name].git
    - -

    - In addition to this primary repository, there are the following read-only git - repositories which mirror the master one. Note that we currently do not - use the full set of features on these mirrors (e.g. pull requests on - GitHub, so please don't use them). All patch review and discussion only - occurs on the libvir-list mailing list. Also - note that some repositories listed below allow HTTP checkouts too. -

    - - 
    -https://github.com/libvirt/
-https://gitlab.com/libvirt/
    - -

    Signing keys

    - -

    - Source RPM packages and tarballs for libvirt and libvirt-python published - on this project site are signed with a GPG signature. You should always - verify the package signature before using the source to compile binary - packages. The following key is currently used to generate the GPG - signatures: -

    - 
    -pub  4096R/10084C9C 2020-07-20 Jiří Denemark <jdenemar@redhat.com>
-Fingerprint=453B 6531 0595 5628 5547  1199 CA68 BE80 1008 4C9C
-
    - -

    - It can be downloaded from - this site or from - public GPG key servers. -

    - -

    - Releases prior to libvirt-6.6 were signed with the following GPG key: -

    - - 
    -pub   dsa1024 2000-05-31 [SC]
-C744 15BA 7C9C 7F78 F02E  1DC3 4606 B8A5 DE95 BC1F
-uid           [ unknown] Daniel Veillard (Red Hat work email) <veillard@redhat.com>
-uid           [ unknown] Daniel Veillard <Daniel.Veillard@w3.org>
-
    - - 
    ------BEGIN PGP SIGNED MESSAGE-----
-Hash: SHA256
-
-Starting from libvirt-6.6.0 the upstream releases will be done by Jiří Denemark
-signed with his PGP key:
-
-pub  4096R/10084C9C 2020-07-20 Jiří Denemark <jdenemar@redhat.com>
-Fingerprint=453B 6531 0595 5628 5547  1199 CA68 BE80 1008 4C9C
-
-This message is signed by the old signing key which was used for previous
-releases.
------BEGIN PGP SIGNATURE-----
-
-iQEzBAEBCAAdFiEE20ZoG7ka3OoXD6LUFViLJllr6l0FAl/8H9cACgkQFViLJllr
-6l3iVwgAm9n703/QoIfPbxT5qGQzWK6LNriEcG2R9MLgFcW+UuGA9cqIBLhH1RaJ
-q7Gc3gK0dgE2HAF6DxuG5+nkDY6LdmonLOVFWQkMCh41JHFrV6tw8y9hc/RNOb/m
-gFAl4HpwYisjTRvsTRcpR3ElK6lI0Yu4GY4gJxj5qH4L5exR+kkylwuAxqP+wuyY
-b/L/tP76F4+Q9SSPj0M01NRVC7V8m3yvnok5y374vtxvRFome0WMELn81vphxBLx
-X7LQ1LyjvRs0HhN5MutJES5FYDzArTYZfZJozJgE465XrHxMMCbXbZ/AgAs/aD+5
-x+m2mFplbS57tMEoMBP/ezbbL5wpvA==
-=KnaO
------END PGP SIGNATURE-----
-
    - - - diff --git a/docs/downloads.rst b/docs/downloads.rst new file mode 100644 index 0000000000..74a788c6bb --- /dev/null +++ b/docs/downloads.rst @@ -0,0 +1,418 @@ +========= +Downloads +========= + +.. contents:: + +Project modules +--------------- + +The libvirt project maintains a number of inter-related modules beyond the core +C library/daemon. + +Libvirt +~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Module + - Releases + - GIT Repo + - Bug Tracker + - GIT Mirrors + - Resources + + * - libvirt + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - `api ref `__ + `changes `__ + +Language bindings +~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Module + - Releases + - GIT Repo + - Bug Tracker + - GIT Mirrors + - Resources + + * - C# + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - Go + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - `api ref `__ + + * - Java + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - OCaml + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - Perl (Sys::Virt) + - `cpan `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - `api ref `__ + `changes `__ + + * - PHP + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - Python + - `libvirt `__ + `pypi `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - Ruby + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - Rust + - `crates.io `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - `api ref `__ + +Integration modules +~~~~~~~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Module + - Releases + - GIT Repo + - Bug Tracker + - GIT Mirrors + - Resources + + * - GLib / GConfig / GObject + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - Go XML + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - `api ref `__ + + * - D-Bus + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - Console Proxy + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - CIM provider + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - CIM utils + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - SNMP + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + + * - Application Sandbox + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + - + +Testing +~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Module + - Releases + - GIT Repo + - Bug Tracker + - GIT Mirrors + + * - TCK + - `libvirt `__ + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + + * - Test API + - + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + + * - Continuous Integration Config + - + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + + * - CIM Test + - + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + +Documentation +~~~~~~~~~~~~~ + +.. list-table:: + :header-rows: 1 + + * - Module + - GIT Repo + - Bug Tracker + - GIT Mirrors + + * - Publican Brand + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + + * - App Development Guide + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + + * - App Development Guide Python + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + + * - virsh Command Reference + - `gitlab `__ + - `issues `__ + - `libvirt `__ + `github `__ + +Primary download site +--------------------- + +Most modules have releases made available for download on the project site via +HTTPS. Some modules are instead made available at alternative locations, for +example, the Perl binding is made available only on CPAN. + +- `libvirt.org HTTPS server `__ + +Primary release schedule +------------------------ + +The core libvirt module follows a time based plan, with releases made once a +month on the 1st of each month give or take a few days. The only exception is at +the start of the year where there are two 6 weeks gaps (first release in the +middle of Jan, then skip the Feb release), giving a total of 11 releases a year. +The Python and Perl modules will aim to release at the same time as the core +libvirt module. Other modules have independent ad-hoc releases with no fixed +time schedule. + +Release numbering +----------------- + +Since libvirt 2.0.0, a time based version numbering rule is applied to the core +library releases. As such, the changes in version number have do not have any +implications with respect to the scope of features or bugfixes included, the +stability of the code, or the API / ABI compatibility (libvirt API / ABI is +guaranteed stable forever). The rules applied for changing the libvirt version +number are: + +``major`` + incremented by 1 for the first release of the year (the Jan 15th release) +``minor`` + reset to 0 with every major increment, otherwise incremented by 1 for each + monthly release from git master +``micro`` + always 0 for releases from git master, incremented by 1 for each stable + maintenance release + +Prior to 2.0.0, the major/minor numbers were incremented fairly arbitrarily, and +maintenance releases appended a fourth digit. The language bindings will aim to +use the same version number as the most recent core library API they support. +The other modules have their own distinct release numbering sequence, though +they generally aim to follow the above rules for incrementing major/minor/micro +digits. + +Maintenance releases +-------------------- + +In the git repository are several stable maintenance branches for the core +library, matching the pattern ``vmajor.minor-maint``; these branches are forked +off the corresponding ``vmajor.minor.0`` formal release, and may have further +releases of the form ``vmajor.minor.micro``. These maintenance branches should +only contain bug fixes, and no new features, backported from the master branch, +and are supported as long as at least one downstream distribution expresses +interest in a given branch. These maintenance branches are considered during CVE +analysis. In contrast to the primary releases which are made once a month, there +is no formal schedule for the maintenance releases, which are made whenever +there is a need to make available key bugfixes to downstream consumers. The +language bindings and other modules generally do not provide stable branch +releases. + +For more details about contents of maintenance releases, see `the wiki +page `__. + +GIT source repository +--------------------- + +All modules maintained by the libvirt project have their primary source +available in the `project GIT server `__. Each module +can be cloned anonymously using: + +:: + + git clone https://libvirt.org/git/[module name].git + +The ``git://`` protocol is also available if desired, but ``https://`` is +encouraged, since it is more reliable when faced with strict firewalls. + +:: + + git clone git://libvirt.org/[module name].git + +In addition to this primary repository, there are the following read-only git +repositories which mirror the master one. Note that we currently do not use the +full set of features on these mirrors (e.g. pull requests on GitHub, so please +don't use them). All patch review and discussion only occurs on the +`libvir-list `__ mailing list. Also note that some repositories +listed below allow HTTP checkouts too. + +:: + + https://github.com/libvirt/ + https://gitlab.com/libvirt/ + +Signing keys +------------ + +Source RPM packages and tarballs for libvirt and libvirt-python published on +this project site are signed with a GPG signature. You should always verify the +package signature before using the source to compile binary packages. The +following key is currently used to generate the GPG signatures: + +:: + + pub 4096R/10084C9C 2020-07-20 Jiří Denemark + Fingerprint=453B 6531 0595 5628 5547 1199 CA68 BE80 1008 4C9C + +It can be downloaded from `this +site `__ or from public GPG key +servers. + +Releases prior to libvirt-6.6 were signed with the following GPG key: + +:: + + pub dsa1024 2000-05-31 [SC] + C744 15BA 7C9C 7F78 F02E 1DC3 4606 B8A5 DE95 BC1F + uid [ unknown] Daniel Veillard (Red Hat work email) + uid [ unknown] Daniel Veillard + +:: + + -----BEGIN PGP SIGNED MESSAGE----- + Hash: SHA256 + + Starting from libvirt-6.6.0 the upstream releases will be done by Jiří Denemark + signed with his PGP key: + + pub 4096R/10084C9C 2020-07-20 Jiří Denemark + Fingerprint=453B 6531 0595 5628 5547 1199 CA68 BE80 1008 4C9C + + This message is signed by the old signing key which was used for previous + releases. + -----BEGIN PGP SIGNATURE----- + + iQEzBAEBCAAdFiEE20ZoG7ka3OoXD6LUFViLJllr6l0FAl/8H9cACgkQFViLJllr + 6l3iVwgAm9n703/QoIfPbxT5qGQzWK6LNriEcG2R9MLgFcW+UuGA9cqIBLhH1RaJ + q7Gc3gK0dgE2HAF6DxuG5+nkDY6LdmonLOVFWQkMCh41JHFrV6tw8y9hc/RNOb/m + gFAl4HpwYisjTRvsTRcpR3ElK6lI0Yu4GY4gJxj5qH4L5exR+kkylwuAxqP+wuyY + b/L/tP76F4+Q9SSPj0M01NRVC7V8m3yvnok5y374vtxvRFome0WMELn81vphxBLx + X7LQ1LyjvRs0HhN5MutJES5FYDzArTYZfZJozJgE465XrHxMMCbXbZ/AgAs/aD+5 + x+m2mFplbS57tMEoMBP/ezbbL5wpvA== + =KnaO + -----END PGP SIGNATURE----- diff --git a/docs/meson.build b/docs/meson.build index 7146bd078b..c1d4072cf7 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -24,7 +24,6 @@ docs_html_in_files = [ 'csharp', 'dbus', 'docs', - 'downloads', 'drvbhyve', 'drvesx', 'drvhyperv', @@ -85,6 +84,7 @@ docs_rst_files = [ 'contribute', 'daemons', 'developer-tooling', + 'downloads', 'drivers', 'drvch', 'drvqemu', -- 2.47.2