Doc: Correct the name of qemu-img dd parameter

[PATCH] Doc: Correct the name of qemu-img dd parameter

Rajat Dhasmana posted 1 patch 7 months ago

Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20231013110403.231608-1-rajatdhasmana@gmail.com

Maintainers: Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>

docs/tools/qemu-img.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

Expand all Fold all

[PATCH] Doc: Correct the name of qemu-img dd parameter

Posted by Rajat Dhasmana 7 months ago

In the qemu-img documentation, one of the option for the dd command
is mentioned as size whereas it is the skip parameter[1] that is also
available in the dd command.

skip=BLOCKS
    skip BLOCKS ibs-sized blocks at start of input

This patch corrects the documentation.

[1] https://github.com/qemu/qemu/blob/63011373ad22c794a013da69663c03f1297a5c56/qemu-img.c#L229

Signed-off-by: Rajat Dhasmana <rajatdhasmana@gmail.com>
---
 docs/tools/qemu-img.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst
index ca5a2773cf..88ebe35360 100644
--- a/docs/tools/qemu-img.rst
+++ b/docs/tools/qemu-img.rst
@@ -501,7 +501,7 @@ Command description:
   modified by specifying *BLOCK_SIZE*. If count=\ *BLOCKS* is specified
   dd will stop reading input after reading *BLOCKS* input blocks.
 
-  The size syntax is similar to :manpage:`dd(1)`'s size syntax.
+  The skip syntax is similar to :manpage:`dd(1)`'s skip syntax.
 
 .. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=OFMT] [--backing-chain] [-U] FILENAME
 
-- 
2.34.1