openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Convert 'testsuites' page to rST 

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Peter Krempa 2022-03-10 16:36:15 +01:00
parent 0b2dec6af9
commit 688a2c0897
3 changed files with 38 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/meson.build
View File

@ -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',
]

41
docs/testsuites.html.in
View File

@ -1,41 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<body>
<h1>Test suites</h1>
<p>There is a few test suites available to developers for testing
a given version of libvirt:</p>
<ul>
<li>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:
<pre>make check (libvirt 6.6.0 and older)</pre>
<pre>ninja test (libvirt 6.7.0 and newer)</pre>
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.
</li>
<li>the <a href="testtck.html">TCK test suite</a> is a functional
test suite implemented using the
<a href="https://search.cpan.org/dist/Sys-Virt/">Perl bindings</a>
of libvirt. It is available separately as a
<a href="ftp://libvirt.org/libvirt/tck/">download</a>, as a
<a href="https://rpmfind.net/linux/rpm2html/search.php?query=libvirt-tck">package</a>
in Fedora distributions, but best is probably to get
the <a href="https://gitlab.com/libvirt/libvirt-tck">version
from GIT</a>.
</li>
<li>the <a href="testapi.html">libvirt-test-API</a> is also a functional
test suite, but implemented using the
<a href="python.html">Python bindings</a>
of libvirt. It is available separately as a
<a href="ftp://libvirt.org/libvirt/libvirt-test-API/">download</a>,
or directly get
the <a href="https://gitlab.com/libvirt/libvirt-test-API/">version
from GIT</a>.
</li>
</ul>
</body>
</html>

37
docs/testsuites.rst Normal file
View File

@ -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 <testtck.html>`__ is a functional test suite implemented
using the `Perl bindings <https://search.cpan.org/dist/Sys-Virt/>`__ of
libvirt. It is available separately as a
`download <ftp://libvirt.org/libvirt/tck/>`__, as a
`package <https://rpmfind.net/linux/rpm2html/search.php?query=libvirt-tck>`__
in Fedora distributions, but best is probably to get the `version from
GIT <https://gitlab.com/libvirt/libvirt-tck>`__.
- the `libvirt-test-API <testapi.html>`__ is also a functional test suite, but
implemented using the `Python bindings <python.html>`__ of libvirt. It is
available separately as a
`download <ftp://libvirt.org/libvirt/libvirt-test-API/>`__, or directly get
the `version from GIT <https://gitlab.com/libvirt/libvirt-test-API/>`__.