[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 4/8] qemu-img-cmds.hx: Add rST documentation fragments
From: |
Peter Maydell |
Subject: |
[PATCH v2 4/8] qemu-img-cmds.hx: Add rST documentation fragments |
Date: |
Fri, 24 Jan 2020 16:26:02 +0000 |
Add the rST versions of the documentation fragments.
Once we've converted qemu-img.texi to rST we can delete
the texi fragments; for the moment we leave them in place.
(Commit created with the aid of emacs query-replace-regexp
from "@var{\([^}]*\)}" to "\,(upcase \1))".)
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Richard Henderson <address@hidden>
---
qemu-img-cmds.hx | 43 ++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 42 insertions(+), 1 deletion(-)
diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
index 1c93e6d1855..0c8b210b3c3 100644
--- a/qemu-img-cmds.hx
+++ b/qemu-img-cmds.hx
@@ -18,84 +18,125 @@ DEF("amend", img_amend,
STEXI
@item amend [--object @var{objectdef}] [--image-opts] [-p] [-q] [-f @var{fmt}]
[-t @var{cache}] -o @var{options} @var{filename}
ETEXI
+SRST
+.. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [-t
CACHE] -o OPTIONS FILENAME
+ERST
DEF("bench", img_bench,
"bench [-c count] [-d depth] [-f fmt] [--flush-interval=flush_interval]
[-n] [--no-drain] [-o offset] [--pattern=pattern] [-q] [-s buffer_size] [-S
step_size] [-t cache] [-w] [-U] filename")
STEXI
@item bench [-c @var{count}] [-d @var{depth}] [-f @var{fmt}]
[--flush-interval=@var{flush_interval}] [-n] [--no-drain] [-o @var{offset}]
[--pattern=@var{pattern}] [-q] [-s @var{buffer_size}] [-S @var{step_size}] [-t
@var{cache}] [-w] [-U] @var{filename}
ETEXI
-
+SRST
+.. option:: bench [-c COUNT] [-d DEPTH] [-f FMT]
[--flush-interval=FLUSH_INTERVAL] [-n] [--no-drain] [-o OFFSET]
[--pattern=PATTERN] [-q] [-s BUFFER_SIZE] [-S STEP_SIZE] [-t CACHE] [-w] [-U]
FILENAME
+ERST
DEF("check", img_check,
"check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=ofmt]
[-r [leaks | all]] [-T src_cache] [-U] filename")
STEXI
@item check [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}]
[--output=@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] [-U]
@var{filename}
ETEXI
+SRST
+.. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT]
[--output=OFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME
+ERST
DEF("commit", img_commit,
"commit [--object objectdef] [--image-opts] [-q] [-f fmt] [-t cache] [-b
base] [-d] [-p] filename")
STEXI
@item commit [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] [-t
@var{cache}] [-b @var{base}] [-d] [-p] @var{filename}
ETEXI
+SRST
+.. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t
CACHE] [-b BASE] [-d] [-p] FILENAME
+ERST
DEF("compare", img_compare,
"compare [--object objectdef] [--image-opts] [-f fmt] [-F fmt] [-T
src_cache] [-p] [-q] [-s] [-U] filename1 filename2")
STEXI
@item compare [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-F
@var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] [-U] @var{filename1}
@var{filename2}
ETEXI
+SRST
+.. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] [-T
SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2
+ERST
DEF("convert", img_convert,
"convert [--object objectdef] [--image-opts] [--target-image-opts] [-U]
[-C] [-c] [-p] [-q] [-n] [-f fmt] [-t cache] [-T src_cache] [-O output_fmt] [-B
backing_file] [-o options] [-l snapshot_param] [-S sparse_size] [-m
num_coroutines] [-W] [--salvage] filename [filename2 [...]] output_filename")
STEXI
@item convert [--object @var{objectdef}] [--image-opts] [--target-image-opts]
[-U] [-C] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T
@var{src_cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o
@var{options}] [-l @var{snapshot_param}] [-S @var{sparse_size}] [-m
@var{num_coroutines}] [-W] [--salvage] @var{filename} [@var{filename2} [...]]
@var{output_filename}
ETEXI
+SRST
+.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-opts]
[-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O
OUTPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZE]
[-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME
+ERST
DEF("create", img_create,
"create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F
backing_fmt] [-u] [-o options] filename [size]")
STEXI
@item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-b
@var{backing_file}] [-F @var{backing_fmt}] [-u] [-o @var{options}]
@var{filename} [@var{size}]
ETEXI
+SRST
+.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE] [-F
BACKING_FMT] [-u] [-o OPTIONS] FILENAME [SIZE]
+ERST
DEF("dd", img_dd,
"dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=block_size]
[count=blocks] [skip=blocks] if=input of=output")
STEXI
@item dd [--image-opts] [-U] [-f @var{fmt}] [-O @var{output_fmt}]
[bs=@var{block_size}] [count=@var{blocks}] [skip=@var{blocks}] if=@var{input}
of=@var{output}
ETEXI
+SRST
+.. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=BLOCK_SIZE]
[count=BLOCKS] [skip=BLOCKS] if=INPUT of=OUTPUT
+ERST
DEF("info", img_info,
"info [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt]
[--backing-chain] [-U] filename")
STEXI
@item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}]
[--output=@var{ofmt}] [--backing-chain] [-U] @var{filename}
ETEXI
+SRST
+.. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT]
[--backing-chain] [-U] FILENAME
+ERST
DEF("map", img_map,
"map [--object objectdef] [--image-opts] [-f fmt] [--output=ofmt] [-U]
filename")
STEXI
@item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}]
[--output=@var{ofmt}] [-U] @var{filename}
ETEXI
+SRST
+.. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT]
[-U] FILENAME
+ERST
DEF("measure", img_measure,
"measure [--output=ofmt] [-O output_fmt] [-o options] [--size N | [--object
objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]")
STEXI
@item measure [--output=@var{ofmt}] [-O @var{output_fmt}] [-o @var{options}]
[--size @var{N} | [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-l
@var{snapshot_param}] @var{filename}]
ETEXI
+SRST
+.. option:: measure [--output=OFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size N |
[--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILENAME]
+ERST
DEF("snapshot", img_snapshot,
"snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snapshot
| -c snapshot | -d snapshot] filename")
STEXI
@item snapshot [--object @var{objectdef}] [--image-opts] [-U] [-q] [-l | -a
@var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename}
ETEXI
+SRST
+.. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -a
SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME
+ERST
DEF("rebase", img_rebase,
"rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cache]
[-T src_cache] [-p] [-u] -b backing_file [-F backing_fmt] filename")
STEXI
@item rebase [--object @var{objectdef}] [--image-opts] [-U] [-q] [-f
@var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u] -b
@var{backing_file} [-F @var{backing_fmt}] @var{filename}
ETEXI
+SRST
+.. option:: rebase [--object OBJECTDEF] [--image-opts] [-U] [-q] [-f FMT] [-t
CACHE] [-T SRC_CACHE] [-p] [-u] -b BACKING_FILE [-F BACKING_FMT] FILENAME
+ERST
DEF("resize", img_resize,
"resize [--object objectdef] [--image-opts] [-f fmt]
[--preallocation=prealloc] [-q] [--shrink] filename [+ | -]size")
STEXI
@item resize [--object @var{objectdef}] [--image-opts] [-f @var{fmt}]
[--preallocation=@var{prealloc}] [-q] [--shrink] @var{filename} [+ |
-]@var{size}
ETEXI
+SRST
+.. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT]
[--preallocation=PREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE
+ERST
STEXI
@end table
--
2.20.1
- [PATCH v2 0/8] qemu-img, qemu-trace-stap, virtfs-proxy-helper: convert to rST, Peter Maydell, 2020/01/24
- [PATCH v2 1/8] Makefile: Ensure we don't run Sphinx in parallel for manpages, Peter Maydell, 2020/01/24
- [PATCH v2 2/8] hxtool: Support SRST/ERST directives, Peter Maydell, 2020/01/24
- [PATCH v2 3/8] docs/sphinx: Add new hxtool Sphinx extension, Peter Maydell, 2020/01/24
- [PATCH v2 4/8] qemu-img-cmds.hx: Add rST documentation fragments,
Peter Maydell <=
- [PATCH v2 6/8] qemu-img-cmds.hx: Remove texinfo document fragments, Peter Maydell, 2020/01/24
- [PATCH v2 7/8] scripts/qemu-trace-stap: Convert documentation to rST, Peter Maydell, 2020/01/24
- [PATCH v2 8/8] virtfs-proxy-helper: Convert documentation to rST, Peter Maydell, 2020/01/24
- [PATCH v2 5/8] qemu-img: Convert invocation documentation to rST, Peter Maydell, 2020/01/24
- Re: [PATCH v2 0/8] qemu-img, qemu-trace-stap, virtfs-proxy-helper: convert to rST, Peter Maydell, 2020/01/31