Define what users should look for when wanting to manipulate bitmaps
themselves.

Later on a patch will turn the bash algorithms into pseudocode for
simplicity.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
---
 docs/kbase/incrementalbackupinternals.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/docs/kbase/incrementalbackupinternals.rst b/docs/kbase/incrementalbackupinternals.rst
index adc415e282..c8a0a66baa 100644
--- a/docs/kbase/incrementalbackupinternals.rst
+++ b/docs/kbase/incrementalbackupinternals.rst
@@ -190,6 +190,20 @@ It's reccomended to use ``--output=json`` parameter to work with a machine
 readable output rather than trying to process the human readable output by
 scripts. For processing JSON in shell the ``jq`` tool can be used.

+``qemu-img bitmap`` command allows modification of block-dirty-bitmaps of an
+image. It supports the following operations relevant to this document (see man
+page for full list of operations):
+
+``--add NAME``
+    Creates a new bitmap named ``NAME``. Optionally ``-g`` can be used to
+    specify granularity.
+
+``--remove NAME``
+    Deletes bitmap ``NAME``.
+
+``--merge SRCBITMAP -b SRCFILE -F SRCFILEFMT DSTBITMAP``
+    Merges bitmap ``SRCBITMAP`` from ``SRCFILE`` into ``DSTBITMAP``.
+
 Checking bitmap health
 ----------------------

-- 
2.26.2

On 6/24/20 9:07 AM, Peter Krempa wrote:
> Define what users should look for when wanting to manipulate bitmaps
> themselves.
> 
> Later on a patch will turn the bash algorithms into pseudocode for
> simplicity.
> 
> Signed-off-by: Peter Krempa <pkrempa@redhat.com>
> ---
>   docs/kbase/incrementalbackupinternals.rst | 14 ++++++++++++++
>   1 file changed, 14 insertions(+)
> 
> diff --git a/docs/kbase/incrementalbackupinternals.rst b/docs/kbase/incrementalbackupinternals.rst
> index adc415e282..c8a0a66baa 100644
> --- a/docs/kbase/incrementalbackupinternals.rst
> +++ b/docs/kbase/incrementalbackupinternals.rst
> @@ -190,6 +190,20 @@ It's reccomended to use ``--output=json`` parameter to work with a machine
>   readable output rather than trying to process the human readable output by
>   scripts. For processing JSON in shell the ``jq`` tool can be used.
> 
> +``qemu-img bitmap`` command allows modification of block-dirty-bitmaps of an

s/``qemu-img/The ``qemu-img/
s/an/an offline/

> +image. It supports the following operations relevant to this document (see man
> +page for full list of operations):
> +
> +``--add NAME``
> +    Creates a new bitmap named ``NAME``. Optionally ``-g`` can be used to
> +    specify granularity.
> +
> +``--remove NAME``
> +    Deletes bitmap ``NAME``.
> +
> +``--merge SRCBITMAP -b SRCFILE -F SRCFILEFMT DSTBITMAP``
> +    Merges bitmap ``SRCBITMAP`` from ``SRCFILE`` into ``DSTBITMAP``.
> +
>   Checking bitmap health
>   ----------------------
> 

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org