[PATCH 7/8] docs: Convert 'testtck' page to rST

Thu Mar 10 15:51:29 UTC 2022

Signed-off-by: Peter Krempa <pkrempa at redhat.com>
---
 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 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body>
-    <h1>libvirt TCK  : Technology Compatibility Kit</h1>
-    <p>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.</p>
-    <p>In particular the libvirt TCK is intended to address the following
-    scenarios:</p>
-    <ul>
-      <li>Validate that a new libvirt driver is in compliance
-          with the (possibly undocumented!) driver API semantics</li>
-      <li>Validate that an update to an existing driver does not
-         change the API semantics in a non-compliant manner</li>
-      <li>Validate that a new hypervisor release is still providing
-         compatibility with the corresponding libvirt driver usage</li>
-      <li>Validate that an OS distro deployment consisting of a
-         hypervisor and libvirt release is configured correctly</li>
-    </ul>
-    <p>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.</p>
-    <p>For more details you can look at:</p>
-    <ul>
-      <li> The initial
-<a href="https://www.redhat.com/archives/libvir-list/2009-April/msg00176.html">mail
-           from Daniel Berrange</a> presenting the project.</li>
-      <li> The <a href="https://fedoraproject.org/wiki/Features/VirtTCK">page
-           describing VirtTCK</a> the inclusion of libvirt-TCK as a
-           Fedora Feature.</li>
-    </ul>
-    <p> Libvirt-TCK is maintained using
-        <a href="https://gitlab.com/libvirt/libvirt-tck">a GIT
-        repository</a>, and comment, patches and reviews are carried
-        on the <a href="contact.html">libvir-list</a> development list.</p>
-  </body>
-</html>
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 <https://www.redhat.com/archives/libvir-list/2009-April/msg00176.html>`__
+   presenting the project.
+-  The `page describing
+   VirtTCK <https://fedoraproject.org/wiki/Features/VirtTCK>`__ the inclusion of
+   libvirt-TCK as a Fedora Feature.
+
+Libvirt-TCK is maintained using `a GIT
+repository <https://gitlab.com/libvirt/libvirt-tck>`__, and comment, patches and
+reviews are carried on the `libvir-list <contact.html>`__ development list.
-- 
2.35.1

