Skip to content

docs/interop/bitmaps: rewrite and modernize doc

John Snow qemu-devel 3 versions – In review

Get series with b4
b4 am [email protected]

Versions newest first · linked by author and title

  1. v3 Latest2 patches 5 repliesIn review
  2. v22 patches 7 repliesSuperseded
  3. v11 patch 2 repliesSuperseded

Changes in v3 from the cover letter

- Added -W flag to patch 1/2
- Addressed comments from Vladimir on patch 2/2.

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/2Makefile: add nit-picky mode to sphinx-buildMakefile+1 -12 replies
2/2docs/interop/bitmaps: rewrite and modernize docdocs/interop/bitmaps.rst+1264 -3353 replies

Reviews trailers per patch

All 2 patches have a Reviewed-by or Acked-by.

PatchVladimir Sementsov-Ogievskiy
1/2R-b
2/2R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v3 thread

Cover letter [Qemu-devel] [PATCH v3 0/2] docs/interop/bitmaps: rewrite and modernize doc

The documentation as written in the 4.0 release is not quite correct as of the 4.0 release; though thanks to backwards compatibility it's not quite wrong either. It is suitable for inclusion in 4.0.1, or any downstream that packages 4.0.

This patch is an attempt at a nearly full rewrite that revitalizes this document to address frequent questions I encounter when discussing the API.

V3:
- Added -W flag to patch 1/2
- Addressed comments from Vladimir on patch 2/2.

V2:
- Split off makefile change into its own little patch.

- Addressed (almost) all comments from Vladimir.
- Example styling was not reworked.
- Renamed all filenames to be consistent throughout the document, fixing a few more file extensions in the process
- Reflowed almost all paragraphs to 78 columns for consistency.
- Changed a few bulleted lists to paragraphs instead
- Changed the big ascii text diagram to a more compact version and clarified its language
- While in general I prefer to use en_US spellings, I have replaced "canceled" with "cancelled" so it does not look out of place juxtaposed with BLOCK_JOB_CANCELLED...

Future work that remains to be done:

- Paying heed to blockdev-backup workflows
- Adding a small migration section explaining the options there
- Possibly reworking some of the sections that all make their own repeated attempts to clarify time interval discretization and adding a proper treatment of the idea start to finish; this may be neccessary to explain the two below items properly:
- Differential Backups
- Pull Backups and NBD

John Snow (2):
Makefile: add nit-picky mode to sphinx-build
docs/interop/bitmaps: rewrite and modernize doc

 docs/interop/bitmaps.rst | 1599 ++++++++++++++++++++++++++++++--------
 Makefile                 |    2 +-
 2 files changed, 1265 insertions(+), 336 deletions(-)
Signature · 1 line
2.20.1