aboutsummaryrefslogtreecommitdiff
path: root/docs/tools/qemu-img.rst
diff options
context:
space:
mode:
authorRichard Henderson <richard.henderson@linaro.org>2021-11-22 23:21:28 +0100
committerRichard Henderson <richard.henderson@linaro.org>2021-11-22 23:21:28 +0100
commit3c87012e3887e8a904a3494283c4acfa7ef777dc (patch)
tree41710dbc85d1f481b46f06e103082092e1ca884a /docs/tools/qemu-img.rst
parentd8a6311dabe62b7d3553915511e9d61fc3556eb6 (diff)
parentc5ba62195427d65a44472901cff3dddffc14b3b3 (diff)
Merge tag 'pull-request-2021-11-22' of https://gitlab.com/thuth/qemu into staging
* Documentation updates # gpg: Signature made Mon 22 Nov 2021 03:05:39 PM CET # gpg: using RSA key 27B88847EEE0250118F3EAB92ED9D774FE702DB5 # gpg: issuer "thuth@redhat.com" # gpg: Good signature from "Thomas Huth <th.huth@gmx.de>" [full] # gpg: aka "Thomas Huth <thuth@redhat.com>" [full] # gpg: aka "Thomas Huth <th.huth@posteo.de>" [unknown] # gpg: aka "Thomas Huth <huth@tuxfamily.org>" [full] * tag 'pull-request-2021-11-22' of https://gitlab.com/thuth/qemu: docs: Render binary names as monospaced text docs: Use double quotes instead of single quotes for COLO docs: Drop deprecated 'props' from object-add Fix some typos in documentation (found by codespell) docs: List more commit-message tags in "submitting-a-patch" docs: Fix botched rST conversion of 'submitting-a-patch.rst' Signed-off-by: Richard Henderson <richard.henderson@linaro.org>
Diffstat (limited to 'docs/tools/qemu-img.rst')
-rw-r--r--docs/tools/qemu-img.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst
index c0a4443146..d663dd92bd 100644
--- a/docs/tools/qemu-img.rst
+++ b/docs/tools/qemu-img.rst
@@ -127,9 +127,9 @@ by the used format or see the format descriptions below for details.
.. option:: -S SIZE
Indicates the consecutive number of bytes that must contain only zeros
- for qemu-img to create a sparse image during conversion. This value is rounded
- down to the nearest 512 bytes. You may use the common size suffixes like
- ``k`` for kilobytes.
+ for ``qemu-img`` to create a sparse image during conversion. This value is
+ rounded down to the nearest 512 bytes. You may use the common size suffixes
+ like ``k`` for kilobytes.
.. option:: -t CACHE
@@ -431,7 +431,7 @@ Command description:
suppressed from the destination image.
*SPARSE_SIZE* indicates the consecutive number of bytes (defaults to 4k)
- that must contain only zeros for qemu-img to create a sparse image during
+ that must contain only zeros for ``qemu-img`` to create a sparse image during
conversion. If *SPARSE_SIZE* is 0, the source will not be scanned for
unallocated or zero sectors, and the destination image will always be
fully allocated.
@@ -447,7 +447,7 @@ Command description:
If the ``-n`` option is specified, the target volume creation will be
skipped. This is useful for formats such as ``rbd`` if the target
volume has already been created with site specific options that cannot
- be supplied through qemu-img.
+ be supplied through ``qemu-img``.
Out of order writes can be enabled with ``-W`` to improve performance.
This is only recommended for preallocated devices like host devices or other
@@ -472,7 +472,7 @@ Command description:
If the option *BACKING_FILE* is specified, then the image will record
only the differences from *BACKING_FILE*. No size needs to be specified in
this case. *BACKING_FILE* will never be modified unless you use the
- ``commit`` monitor command (or qemu-img commit).
+ ``commit`` monitor command (or ``qemu-img commit``).
If a relative path name is given, the backing file is looked up relative to
the directory containing *FILENAME*.
@@ -684,7 +684,7 @@ Command description:
Safe mode
This is the default mode and performs a real rebase operation. The
- new backing file may differ from the old one and qemu-img rebase
+ new backing file may differ from the old one and ``qemu-img rebase``
will take care of keeping the guest-visible content of *FILENAME*
unchanged.
@@ -697,7 +697,7 @@ Command description:
exists.
Unsafe mode
- qemu-img uses the unsafe mode if ``-u`` is specified. In this
+ ``qemu-img`` uses the unsafe mode if ``-u`` is specified. In this
mode, only the backing file name and format of *FILENAME* is changed
without any checks on the file contents. The user must take care of
specifying the correct new backing file, or the guest-visible
@@ -735,7 +735,7 @@ Command description:
sizes accordingly. Failure to do so will result in data loss!
When shrinking images, the ``--shrink`` option must be given. This informs
- qemu-img that the user acknowledges all loss of data beyond the truncated
+ ``qemu-img`` that the user acknowledges all loss of data beyond the truncated
image's end.
After using this command to grow a disk image, you must use file system and