]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
projects / thirdparty / libvirt.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 849e563)
docs: Convert 'drvtest' page to rST
authorPeter Krempa <pkrempa@redhat.com>
Thu, 10 Mar 2022 16:57:53 +0000 (17:57 +0100)
committerPeter Krempa <pkrempa@redhat.com>
Fri, 1 Apr 2022 14:33:19 +0000 (16:33 +0200)
The first sentence was moved up a paragraph to stop treating the first
sub-heading as a page subtitle.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
docs/drvtest.html.in [deleted file] patch | blob | blame | history
docs/drvtest.rst [new file with mode: 0644] patch | blob
docs/meson.build patch | blob | blame | history

diff --git a/docs/drvtest.html.in b/docs/drvtest.html.in
deleted file mode 100644 (file)
index 6884184..0000000
--- a/docs/drvtest.html.in
+++ /dev/null
@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body>
-    <h1>Test "mock" driver</h1>
-
-    <h2>Connections to Test driver</h2>
-
-    <p>
-    The libvirt Test driver is a per-process fake hypervisor driver,
-    with a driver name of 'test'. The driver maintains all its state
-    in memory. It can start with a pre-configured default config, or
-    be given a path to an alternate config. Some example connection URIs
-    for the libvirt driver are:
-    </p>
-
-<pre>
-test:///default                     (local access, default config)
-test:///path/to/driver/config.xml   (local access, custom config)
-test+unix:///default                (local access, default config, via daemon)
-test://example.com/default          (remote access, TLS/x509)
-test+tcp://example.com/default      (remote access, SASl/Kerberos)
-test+ssh://root@example.com/default (remote access, SSH tunnelled)
-</pre>
-
-  </body>
-</html>
diff --git a/docs/drvtest.rst b/docs/drvtest.rst
new file mode 100644 (file)
index 0000000..99578a4
--- /dev/null
+++ b/docs/drvtest.rst
@@ -0,0 +1,21 @@
+==================
+Test "mock" driver
+==================
+
+The libvirt ``test`` driver is a per-process fake hypervisor driver.
+
+Connections to Test driver
+--------------------------
+
+The driver maintains all its state in memory. It can start with
+a pre-configured default config, or be given a path to an alternate config. Some
+example connection URIs for the libvirt driver are:
+
+::
+
+   test:///default                     (local access, default config)
+   test:///path/to/driver/config.xml   (local access, custom config)
+   test+unix:///default                (local access, default config, via daemon)
+   test://example.com/default          (remote access, TLS/x509)
+   test+tcp://example.com/default      (remote access, SASl/Kerberos)
+   test+ssh://root@example.com/default (remote access, SSH tunnelled)
diff --git a/docs/meson.build b/docs/meson.build
index 8499b3d595aaa95ae47eb88f18eaf407da9fd726..5995b2ec912bc81a6232def5fb1bfc06c98e70e0 100644 (file)
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -22,7 +22,6 @@ docs_html_in_files = [
   'csharp',
   'dbus',
   'docs',
-  'drvtest',
   'drvvbox',
   'drvvirtuozzo',
   'drvvmware',
@@ -81,6 +80,7 @@ docs_rst_files = [
   'drvopenvz',
   'drvqemu',
   'drvsecret',
+  'drvtest',
   'errors',
   'formatbackup',
   'formatcheckpoint',
Mirror of https://github.com/libvirt/libvirt.git