kbase: incrementalbackupinternals: Add section on 'qemu-img bitmap' use

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>
Reviewed-by: Eric Blake <eblake@redhat.com>

diff --git a/docs/kbase/incrementalbackupinternals.rst b/docs/kbase/incrementalbackupinternals.rst
index 0d6c77dfa1651741122bc9958f7fe5cd972a575c..6f087bdb87fc945247ce33a5b059c9c7b83caec0 100644 (file)
--- a/docs/kbase/incrementalbackupinternals.rst
+++ b/docs/kbase/incrementalbackupinternals.rst
@@ -190,6 +190,20 @@ It's recommended 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.
 
+The ``qemu-img bitmap`` command allows modification of block-dirty-bitmaps of 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
 ----------------------