Skip to content

RFC qemu-img: remove command documentation duplication

John Snow qemu-devel 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest3 patches 7 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/3qemu-img: fix .hx and .texi disparityqemu-img-cmds.hx qemu-img.texi+3 -30 replies
2/3pxtool: Add new qemu-img command info generation toolMakefile qemu-img-cmds.hx qemu-img-cmds.json +1 more+218 -1065 replies
3/3qemu-img.texi: use macros for command summariesqemu-img.texi scripts/pxtool.py+18 -140 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [Qemu-devel] [PATCH RFC 0/3] qemu-img: remove command documentation duplication

This might hopefully cut down on the doc duplication/mismatching until I can devise something more comprehensive.

Ideally, I'd like to redo all of the documentation for qemu-img nearly from scratch; with a parser generator that helps generate the documentation as well so they'll never get out of date.

That's probably quite a ways off, and maybe there are other structural changes we want to make with respect to sphinx and other build tools, so I am sending something very minimal instead.

This ought to be functionally identical down to the last char.

(I've re-included patch one which I have sent to the list separately, purely as a dependency if you want to apply these patches.)

John Snow (3):
qemu-img: fix .hx and .texi disparity
pxtool: Add new qemu-img command info generation tool qemu-img.texi: use macros for command summaries

 qemu-img.texi      |  28 ++++----
 Makefile           |   8 +--
 qemu-img-cmds.json | 165 +++++++++++++++++++++++++++++++++++++++++++++
 qemu-img-cmds.hx   | 102 ----------------------------
 scripts/pxtool.py  |  53 +++++++++++++++
 5 files changed, 236 insertions(+), 120 deletions(-)
 create mode 100644 qemu-img-cmds.json
 delete mode 100644 qemu-img-cmds.hx
 create mode 100755 scripts/pxtool.py
Signature · 1 line
2.17.2