From 0b2dec6af9cbba43c5b7830518893cac4b192dee Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Thu, 10 Mar 2022 16:34:51 +0100 Subject: [PATCH] docs: Convert 'testtck' page to rST MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Peter Krempa Reviewed-by: Ján Tomko --- docs/meson.build | 2 +- docs/testtck.html.in | 40 ---------------------------------------- docs/testtck.rst | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 41 deletions(-) delete mode 100644 docs/testtck.html.in create mode 100644 docs/testtck.rst diff --git a/docs/meson.build b/docs/meson.build index cdf78a04b4..d6b944a156 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -56,7 +56,6 @@ docs_html_in_files = [ 'remote', 'storage', 'testsuites', - 'testtck', 'tlscerts', 'uri', 'windows', @@ -112,6 +111,7 @@ docs_rst_files = [ 'submitting-patches', 'support', 'testapi', + 'testtck', ] # list of web targets to build for docs/web rule diff --git a/docs/testtck.html.in b/docs/testtck.html.in deleted file mode 100644 index 137586682b..0000000000 --- a/docs/testtck.html.in +++ /dev/null @@ -1,40 +0,0 @@ - - - - -

libvirt TCK : Technology Compatibility Kit

-

The libvirt TCK provides a framework for performing testing - of the integration between libvirt drivers, the underlying virt - hypervisor technology, related operating system services and system - configuration. The idea (and name) is motivated by the Java TCK.

-

In particular the libvirt TCK is intended to address the following - scenarios:

-
    -
  • Validate that a new libvirt driver is in compliance - with the (possibly undocumented!) driver API semantics
    • -
  • Validate that an update to an existing driver does not - change the API semantics in a non-compliant manner
    • -
  • Validate that a new hypervisor release is still providing - compatibility with the corresponding libvirt driver usage
    • -
  • Validate that an OS distro deployment consisting of a - hypervisor and libvirt release is configured correctly
    • -
-

Thus the libvirt TCK will allow developers, administrators and users - to determine the level of compatibility of their platform, and - evaluate whether it will meet their needs, and get awareness of any - regressions that may have occurred since a previous test run.

-

For more details you can look at:

- -

Libvirt-TCK is maintained using - a GIT - repository, and comment, patches and reviews are carried - on the libvir-list development list.

- - diff --git a/docs/testtck.rst b/docs/testtck.rst new file mode 100644 index 0000000000..51de095657 --- /dev/null +++ b/docs/testtck.rst @@ -0,0 +1,37 @@ +========================================== +libvirt TCK : Technology Compatibility Kit +========================================== + +The libvirt TCK provides a framework for performing testing of the integration +between libvirt drivers, the underlying virt hypervisor technology, related +operating system services and system configuration. The idea (and name) is +motivated by the Java TCK. + +In particular the libvirt TCK is intended to address the following scenarios: + +- Validate that a new libvirt driver is in compliance with the (possibly + undocumented!) driver API semantics +- Validate that an update to an existing driver does not change the API + semantics in a non-compliant manner +- Validate that a new hypervisor release is still providing compatibility with + the corresponding libvirt driver usage +- Validate that an OS distro deployment consisting of a hypervisor and libvirt + release is configured correctly + +Thus the libvirt TCK will allow developers, administrators and users to +determine the level of compatibility of their platform, and evaluate whether it +will meet their needs, and get awareness of any regressions that may have +occurred since a previous test run. + +For more details you can look at: + +- The initial `mail from Daniel + Berrange `__ + presenting the project. +- The `page describing + VirtTCK `__ the inclusion of + libvirt-TCK as a Fedora Feature. + +Libvirt-TCK is maintained using `a GIT +repository `__, and comment, patches and +reviews are carried on the `libvir-list `__ development list.