From 688a2c0897c9ce57f715f46b6dece343efc5ce75 Mon Sep 17 00:00:00 2001 From: Peter Krempa Date: Thu, 10 Mar 2022 16:36:15 +0100 Subject: [PATCH] docs: Convert 'testsuites' 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/testsuites.html.in | 41 ----------------------------------------- docs/testsuites.rst | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 42 deletions(-) delete mode 100644 docs/testsuites.html.in create mode 100644 docs/testsuites.rst diff --git a/docs/meson.build b/docs/meson.build index d6b944a156..868267b764 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -55,7 +55,6 @@ docs_html_in_files = [ 'python', 'remote', 'storage', - 'testsuites', 'tlscerts', 'uri', 'windows', @@ -111,6 +110,7 @@ docs_rst_files = [ 'submitting-patches', 'support', 'testapi', + 'testsuites', 'testtck', ] diff --git a/docs/testsuites.html.in b/docs/testsuites.html.in deleted file mode 100644 index 2e61684b63..0000000000 --- a/docs/testsuites.html.in +++ /dev/null @@ -1,41 +0,0 @@ - - - - -

Test suites

-

There is a few test suites available to developers for testing - a given version of libvirt:

-
    -
  • the internal test suite: present in the source code, it is run - by developers before submitting patches upstream, it is also - suggested to have it run and pass as part of the packaging - process for distributions. It is run by launching: - 
    make check (libvirt 6.6.0 and older)
    - 
    ninja test (libvirt 6.7.0 and newer)
    - in a source tree after compilation has finished. It doesn't - really make functional testing but checks that large portions - of the code not interacting directly with virtualization - functions properly. -
    • -
  • the TCK test suite is a functional - test suite implemented using the - Perl bindings - of libvirt. It is available separately as a - download, as a - package - in Fedora distributions, but best is probably to get - the version - from GIT. -
    • -
  • the libvirt-test-API is also a functional - test suite, but implemented using the - Python bindings - of libvirt. It is available separately as a - download, - or directly get - the version - from GIT. -
    • -
- - diff --git a/docs/testsuites.rst b/docs/testsuites.rst new file mode 100644 index 0000000000..4fc733e615 --- /dev/null +++ b/docs/testsuites.rst @@ -0,0 +1,37 @@ +=========== +Test suites +=========== + +There is a few test suites available to developers for testing a given version +of libvirt: + +- the internal test suite: present in the source code, it is run by developers + before submitting patches upstream, it is also suggested to have it run and + pass as part of the packaging process for distributions. It is run by + launching: + + :: + + make check (libvirt 6.6.0 and older) + + :: + + ninja test (libvirt 6.7.0 and newer) + + in a source tree after compilation has finished. It doesn't really make + functional testing but checks that large portions of the code not interacting + directly with virtualization functions properly. + +- the `TCK test suite `__ is a functional test suite implemented + using the `Perl bindings `__ of + libvirt. It is available separately as a + `download `__, as a + `package `__ + in Fedora distributions, but best is probably to get the `version from + GIT `__. + +- the `libvirt-test-API `__ is also a functional test suite, but + implemented using the `Python bindings `__ of libvirt. It is + available separately as a + `download `__, or directly get + the `version from GIT `__.