From: Stefan Hajnoczi <stefanha@redhat.com>
To: <qemu-devel@nongnu.org>
Cc: <qemu-block@nongnu.org>, Kevin Wolf <kwolf@redhat.com>,
mjt@tls.msk.ru, Stefan Hajnoczi <stefanha@redhat.com>
Subject: [PATCH 3/5] docs: flesh out raw format driver description
Date: Wed, 1 Feb 2023 16:12:32 -0500 [thread overview]
Message-ID: <20230201211234.301918-4-stefanha@redhat.com> (raw)
In-Reply-To: <20230201211234.301918-1-stefanha@redhat.com>
Modernize the description and document the size=/offset= runtime
options.
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
docs/system/qemu-block-drivers.rst.inc | 32 ++++++++++++++++++++++----
1 file changed, 27 insertions(+), 5 deletions(-)
diff --git a/docs/system/qemu-block-drivers.rst.inc b/docs/system/qemu-block-drivers.rst.inc
index be6eec1eb6..ec9ebb2066 100644
--- a/docs/system/qemu-block-drivers.rst.inc
+++ b/docs/system/qemu-block-drivers.rst.inc
@@ -16,11 +16,11 @@ options that are supported for it.
.. option:: raw
Raw disk image format. This format has the advantage of
- being simple and easily exportable to all other emulators. If your
- file system supports *holes* (for example in ext2 or ext3 on
- Linux or NTFS on Windows), then only the written sectors will reserve
- space. Use ``qemu-img info`` to know the real size used by the
- image or ``ls -ls`` on Unix/Linux.
+ being simple and easily exportable to all other emulators. Modern
+ file systems support *holes* (for example in btrfs/XFS/ext4 on
+ Linux or NTFS on Windows) where space is allocated on demand as sectors are
+ written. Use ``qemu-img info`` to know the real size used by the image or
+ ``ls -ls`` on Unix/Linux.
Supported create options:
@@ -33,6 +33,28 @@ options that are supported for it.
for image by writing data to underlying storage. This data may or
may not be zero, depending on the storage location.
+ Supported runtime options:
+
+ .. program:: raw
+ .. option:: offset
+
+ The byte position in the underlying file where the virtual disk starts.
+ This is handy when you want to present just a single partition from a
+ physical disk as the virtual disk. This option is usually used in
+ conjunction with the ``size`` option.
+
+ .. option:: size
+
+ Limit the virtual disk size to the given number of bytes, regardless of how
+ large the underlying file is. This option is usually used in conjunction
+ with the ``offset`` option.
+
+ Note the raw format can be omitted when no runtime options are being used. In
+ that case the raw format does nothing besides forwarding I/O requests to the
+ protocol blockdev. You can improve performance slightly by eliminating
+ ``--blockdev raw,file=file0,node-name=drive0`` and renaming the "file0"
+ blockdev to "drive0".
+
.. program:: image-formats
.. option:: qcow2
--
2.39.1
next prev parent reply other threads:[~2023-02-01 21:13 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-01 21:12 [PATCH 0/5] docs: expand block driver documentation Stefan Hajnoczi
2023-02-01 21:12 ` [PATCH 1/5] docs: expand introduction to disk images Stefan Hajnoczi
2023-02-03 22:52 ` Eric Blake
2023-02-01 21:12 ` [PATCH 2/5] docs: differentiate between block driver create and runtime opts Stefan Hajnoczi
2023-02-03 22:53 ` Eric Blake
2023-02-01 21:12 ` Stefan Hajnoczi [this message]
2023-02-02 9:17 ` [PATCH 3/5] docs: flesh out raw format driver description Daniel P. Berrangé
2023-02-01 21:12 ` [PATCH 4/5] docs: flesh out qcow2 " Stefan Hajnoczi
2023-02-03 22:57 ` Eric Blake
2023-02-01 21:12 ` [PATCH 5/5] docs: add throttle filter description Stefan Hajnoczi
2023-02-03 23:00 ` Eric Blake
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230201211234.301918-4-stefanha@redhat.com \
--to=stefanha@redhat.com \
--cc=kwolf@redhat.com \
--cc=mjt@tls.msk.ru \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).