qemu/docs/tools
Eric Blake 955171e441 qemu-img: Add --skip-broken-bitmaps for 'convert --bitmaps'
The point of 'qemu-img convert --bitmaps' is to be a convenience for
actions that are already possible through a string of smaller
'qemu-img bitmap' sub-commands.  One situation not accounted for
already is that if a source image contains an inconsistent bitmap (for
example, because a qemu process died abruptly before flushing bitmap
state), the user MUST delete those inconsistent bitmaps before
anything else useful can be done with the image.

We don't want to delete inconsistent bitmaps by default: although a
corrupt bitmap is only a loss of optimization rather than a corruption
of user-visible data, it is still nice to require the user to opt in
to the fact that they are aware of the loss of the bitmap.  Still,
requiring the user to check 'qemu-img info' to see whether bitmaps are
consistent, then use 'qemu-img bitmap --remove' to remove offenders,
all before using 'qemu-img convert', is a lot more work than just
adding a knob 'qemu-img convert --bitmaps --skip-broken-bitmaps' which
opts in to skipping the broken bitmaps.

After testing the new option, also demonstrate the way to manually fix
things (either deleting bad bitmaps, or re-creating them as empty) so
that it is possible to convert without the option.

Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1946084
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <20210709153951.2801666-4-eblake@redhat.com>
[eblake: warning message tweak, test enhancements]
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
2021-07-21 14:14:41 -05:00
..
index.rst docs: Remove "Contents:" lines from top-level subsections 2021-07-18 10:59:46 +01:00
qemu-img.rst qemu-img: Add --skip-broken-bitmaps for 'convert --bitmaps' 2021-07-21 14:14:41 -05:00
qemu-nbd.rst qemu-nbd: Permit --shared=0 for unlimited clients 2021-02-12 07:42:08 -06:00
qemu-pr-helper.rst docs: Split qemu-pr-helper documentation into tools manual 2020-11-23 11:10:04 +00:00
qemu-storage-daemon.rst qsd: Document FUSE exports 2021-03-29 18:28:33 +02:00
qemu-trace-stap.rst docs: Move tools documentation to tools manual 2020-02-25 10:48:06 +00:00
virtfs-proxy-helper.rst docs: Move tools documentation to tools manual 2020-02-25 10:48:06 +00:00
virtiofsd.rst virtiofsd: Add an option to enable/disable posix acls 2021-07-05 10:51:26 +01:00