[PATCH] docs: formatdomain: Convert to rst

Peter Krempa pkrempa at redhat.com
Tue Aug 4 07:23:09 UTC 2020

On Mon, Aug 03, 2020 at 20:08:27 +0200, Peter Krempa wrote:
> For now just plain conversion to rst. Anchors which existed until now
> are preserved, but the table of contents now uses the docutils-generated
> ones.
> Additionally <code> which was nested in a link (<a>) was removed as rst
> doesn't support nesting of inline markup.
> The only anchor which wasn't restored is
> 'elementsDiskBackingStoreIndex' and it's only reference was removed.
> Signed-off-by: Peter Krempa <pkrempa at redhat.com>
> ---
> A rebased version of this patch. For now anchors and links are kept
> as-is as there wasn't a consensus on how to approach it.
> This file is a magnet for conflicts so it's broken often and thus
> splitting it up will be made later once I will not get rippling
> conflicts.
> The idea to split up into sections (if we decide to do so) can be done
> incrementally. As a first step the hacky HTML anchors will be removed
> and links will be fixed and then we can split up everyting, but that's
> for later.
> For now I've updated the file manually from the last posting, but you
> can look how I did the automatic part at:
> https://gitlab.com/pipo.sk/libvirt/-/commit/3d7e23948564502ff01160a73abd3973360764d2
>  docs/formatdomain.html.in | 9860 -------------------------------------
>  docs/formatdomain.rst     | 7453 ++++++++++++++++++++++++++++
>  docs/meson.build          |    2 +-
>  3 files changed, 7454 insertions(+), 9861 deletions(-)
>  delete mode 100644 docs/formatdomain.html.in
>  create mode 100644 docs/formatdomain.rst

Forgot to commit the following hunk:

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index a9c4f46843..a39e0c4adf 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -2572,8 +2572,7 @@ paravirtualized driver is specified via the ``disk`` element.
    specified storage volume is of 'file' or 'block' type).

    The ``source`` element may also have the ``index`` attribute with same
-   semantics the `index <#elementsDiskBackingStoreIndex>`__ attribute of
-   ``backingStore``
+   semantics the ``index`` attribute of ``backingStore``.

    The ``source`` element may contain the following sub elements:

More information about the libvir-list mailing list