[libvirt] [PATCH v2 12/15] docs: convert kbase/locking.html.in to RST

Fri Nov 22 14:46:59 UTC 2019

This is a semi-automated conversion. The first conversion is done using
"pandoc -f html -t rst". The result is then editted manually to apply
the desired heading markup, and fix a few things that pandoc gets wrong.

Signed-off-by: Daniel P. Berrangé <berrange at redhat.com>
---
 docs/kbase/locking.html.in | 48 --------------------------------------
 docs/kbase/locking.rst     | 33 ++++++++++++++++++++++++++
 2 files changed, 33 insertions(+), 48 deletions(-)
 delete mode 100644 docs/kbase/locking.html.in
 create mode 100644 docs/kbase/locking.rst

diff --git a/docs/kbase/locking.html.in b/docs/kbase/locking.html.in
deleted file mode 100644
index 4532dbddf9..0000000000
--- a/docs/kbase/locking.html.in
+++ /dev/null
@@ -1,48 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <body>
-    <h1>Virtual machine lock manager</h1>
-
-    <ul id="toc"></ul>
-
-    <p>
-      Libvirt includes a framework for ensuring mutual exclusion
-      between virtual machines using host resources. Typically
-      this is used to prevent two VM processes from having concurrent
-      write access to the same disk image, as this would result in
-      data corruption if the guest was not using a cluster
-      aware filesystem.
-    </p>
-
-    <h2><a id="plugins">Lock manager plugins</a></h2>
-
-    <p>
-      The lock manager framework has a pluggable architecture,
-      to allow different locking technologies to be used.
-    </p>
-
-    <dl>
-      <dt><code>nop</code></dt>
-      <dd>This is a "no op" implementation which does absolutely
-        nothing. This can be used if mutual exclusion between
-        virtual machines is not required, or if it is being
-        solved at another level in the management stack.</dd>
-      <dt><code><a href="locking-lockd.html">lockd</a></code></dt>
-      <dd>This is the current preferred implementation shipped
-        with libvirt. It uses the <code>virtlockd</code> daemon
-        to manage locks using the POSIX fcntl() advisory locking
-        capability. As such it requires a shared filesystem of
-        some kind be accessible to all hosts which share the
-        same image storage.</dd>
-      <dt><code><a href="locking-sanlock.html">sanlock</a></code></dt>
-      <dd>This is an alternative implementation preferred by
-        the oVirt project. It uses a disk paxos algorithm for
-        maintaining continuously renewed leases. In the default
-        setup it requires some shared filesystem, but it is
-        possible to use it in a manual mode where the management
-        application creates leases in SAN storage volumes.
-      </dd>
-    </dl>
-  </body>
-</html>
diff --git a/docs/kbase/locking.rst b/docs/kbase/locking.rst
new file mode 100644
index 0000000000..c0d5e39b2d
--- /dev/null
+++ b/docs/kbase/locking.rst
@@ -0,0 +1,33 @@
+============================
+Virtual machine lock manager
+============================
+
+Libvirt includes a framework for ensuring mutual exclusion between
+virtual machines using host resources. Typically this is used to prevent
+two VM processes from having concurrent write access to the same disk
+image, as this would result in data corruption if the guest was not
+using a cluster aware filesystem.
+
+Lock manager plugins
+====================
+
+The lock manager framework has a pluggable architecture, to allow
+different locking technologies to be used.
+
+nop
+   This is a "no op" implementation which does absolutely nothing. This
+   can be used if mutual exclusion between virtual machines is not
+   required, or if it is being solved at another level in the management
+   stack.
+`lockd <locking-lockd.html>`__
+   This is the current preferred implementation shipped with libvirt. It
+   uses the ``virtlockd`` daemon to manage locks using the POSIX fcntl()
+   advisory locking capability. As such it requires a shared filesystem
+   of some kind be accessible to all hosts which share the same image
+   storage.
+`sanlock <locking-sanlock.html>`__
+   This is an alternative implementation preferred by the oVirt project.
+   It uses a disk paxos algorithm for maintaining continuously renewed
+   leases. In the default setup it requires some shared filesystem, but
+   it is possible to use it in a manual mode where the management
+   application creates leases in SAN storage volumes.
-- 
2.23.0


