[PATCH 1/7] docs: formatstorage: Convert to RST

[Peter Krempa]

On Sun, Dec 19, 2021 at 14:03:44 +0100, Ján Tomko wrote:
> On a Friday in 2021, Peter Krempa wrote:
> > Apart from the bulk conversion itself, the section names 'general
> > metadata' and 'target elements' were duplicated between the storage pool
> > and storage volume sections. To prevent heading name clashes they were
> > renamed appropriately.
> > 
> > Signed-off-by: Peter Krempa <pkrempa at redhat.com>
> > ---
> > docs/formatstorage.html.in | 1000 ------------------------------------
> > docs/formatstorage.rst     |  823 +++++++++++++++++++++++++++++
> > docs/meson.build           |    2 +-
> > 3 files changed, 824 insertions(+), 1001 deletions(-)
> > delete mode 100644 docs/formatstorage.html.in
> > create mode 100644 docs/formatstorage.rst
> > 
> > diff --git a/docs/formatstorage.html.in b/docs/formatstorage.html.in
> > deleted file mode 100644
> > index 9ee5b89ee6..0000000000
> > --- a/docs/formatstorage.html.in
> > +++ /dev/null
> > -    <p>
> > -      Valid features are:
> > -    </p>
> > -    <ul>
> > -      <dd><code>cow</code></dd>
> > -      <dt>Controls whether the filesystem performs copy-on-write (COW) for
> > -        images in the pool. This may only be set for directory / filesystem
> > -        pools on the <code>btrfs</code> filesystem. If not set then libvirt
> > -        will attempt to disable COW on any btrfs filesystems.
> > -        <span class="since">Since 6.6.0</span>.</dt>
> > -    </ul>
> 
> This unordered list disappeared in the new version.

I've converted this paragraph into a standard definition list.

> 
> > +   By default this is specified in bytes, but an optional attribute ``unit`` can
> > +   be specified to adjust the passed value. Values can be: 'B' or 'bytes' for
> > +   bytes, 'KB' (kilobytes, 10\ :sup:`3` or 1000 bytes), 'K' or 'KiB' (kibibytes,
> > +   2\ :sup:`10` or 1024 bytes), 'MB' (megabytes, 10\ :sup:`6` or 1,000,000
> > +   bytes), 'M' or 'MiB' (mebibytes, 2\ :sup:`20` or 1,048,576 bytes), 'GB'
> > +   (gigabytes, 10\ :sup:`9` or 1,000,000,000 bytes), 'G' or 'GiB' (gibibytes,
> > +   2\ :sup:`30` or 1,073,741,824 bytes), 'TB' (terabytes, 10\ :sup:`12` or
> > +   1,000,000,000,000 bytes), 'T' or 'TiB' (tebibytes, 2\ :sup:`40` or
> > +   1,099,511,627,776 bytes), 'PB' (petabytes, 10\ :sup:`15` or
> > +   1,000,000,000,000,000 bytes), 'P' or 'PiB' (pebibytes, 2\ :sup:`50` or
> > +   1,125,899,906,842,624 bytes), 'EB' (exabytes, 10\ :sup:`18` or
> > +   1,000,000,000,000,000,000 bytes), or 'E' or 'EiB' (exbibytes, 2\ :sup:`60` or
> > +   1,152,921,504,606,846,976 bytes). :since:`Since 0.4.1, multi-character
> > +   ``unit`` since 0.9.11`
> 
> You cannot nest :since: and ``
> 
> diff --git a/docs/formatstorage.rst b/docs/formatstorage.rst
> index ae700fef4d..3f81adc6fe 100644
> --- a/docs/formatstorage.rst
> +++ b/docs/formatstorage.rst
> @@ -596,8 +596,8 @@ Storage volume general metadata
>     1,000,000,000,000,000 bytes), 'P' or 'PiB' (pebibytes, 2\ :sup:`50` or
>     1,125,899,906,842,624 bytes), 'EB' (exabytes, 10\ :sup:`18` or
>     1,000,000,000,000,000,000 bytes), or 'E' or 'EiB' (exbibytes, 2\ :sup:`60` or
> -   1,152,921,504,606,846,976 bytes). :since:`Since 0.4.1, multi-character
> -   ``unit`` since 0.9.11`
> +   1,152,921,504,606,846,976 bytes). :since:`Since 0.4.1`, multi-character
> +   ``unit`` :since:`since 0.9.11`
>  ``capacity``
>     Providing the logical capacity for the volume. This value is in bytes by
>     default, but a ``unit`` attribute can be specified with the same semantics as

Ah, you provided a patch doing exactly the same thing I did manually :D