From nobody Wed Oct 29 20:24:45 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) client-ip=208.118.235.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; spf=pass (zoho.com: domain of gnu.org designates 208.118.235.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) by mx.zohomail.com with SMTPS id 1525388538466767.1298509982288; Thu, 3 May 2018 16:02:18 -0700 (PDT) Received: from localhost ([::1]:59507 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fENEv-0005IL-Pg for importer@patchew.org; Thu, 03 May 2018 19:02:17 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:60140) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fEN9t-0001NX-HP for qemu-devel@nongnu.org; Thu, 03 May 2018 18:57:07 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fEN9r-0005uz-Lo for qemu-devel@nongnu.org; Thu, 03 May 2018 18:57:05 -0400 Received: from mx3-rdu2.redhat.com ([66.187.233.73]:40118 helo=mx1.redhat.com) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1fEN9l-0005lu-TV; Thu, 03 May 2018 18:56:57 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 5CFB3406C780; Thu, 3 May 2018 22:56:57 +0000 (UTC) Received: from probe.redhat.com (ovpn-126-131.rdu2.redhat.com [10.10.126.131]) by smtp.corp.redhat.com (Postfix) with ESMTP id 078EB83B68; Thu, 3 May 2018 22:56:56 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org, qemu-block@nongnu.org Date: Thu, 3 May 2018 18:56:47 -0400 Message-Id: <20180503225648.13153-5-jsnow@redhat.com> In-Reply-To: <20180503225648.13153-1-jsnow@redhat.com> References: <20180503225648.13153-1-jsnow@redhat.com> X-Scanned-By: MIMEDefang 2.79 on 10.11.54.5 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.5]); Thu, 03 May 2018 22:56:57 +0000 (UTC) X-Greylist: inspected by milter-greylist-4.5.16 (mx1.redhat.com [10.11.55.5]); Thu, 03 May 2018 22:56:57 +0000 (UTC) for IP:'10.11.54.5' DOMAIN:'int-mx05.intmail.prod.int.rdu2.redhat.com' HELO:'smtp.corp.redhat.com' FROM:'jsnow@redhat.com' RCPT:'' X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 66.187.233.73 Subject: [Qemu-devel] [PATCH 4/5] qemu-img: Make documentation between .texi and .hx consistent X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: qemu-trivial@nongnu.org, John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail: RSF_0 Z_629925259 SPT_0 Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" These are also different and out of order for whatever reason. I'd like to automate this in the future, but for now let's put on the band-aid. In the case of resize, there were options missing from all three docstrings; the new string is based on the code. Signed-off-by: John Snow Reviewed-by: Jeff Cody --- qemu-img-cmds.hx | 4 ++-- qemu-img.texi | 24 ++++++++++++------------ 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx index 8bcefcafe9..84deb858af 100644 --- a/qemu-img-cmds.hx +++ b/qemu-img-cmds.hx @@ -89,9 +89,9 @@ STEXI ETEXI =20 DEF("resize", img_resize, - "resize [--object objectdef] [--image-opts] [-q] [--shrink] filename [= + | -]size") + "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation= =3Dprealloc] [-q] [--shrink] filename [+ | -]size") STEXI -@item resize [--object @var{objectdef}] [--image-opts] [-q] [--shrink] @va= r{filename} [+ | -]@var{size} +@item resize [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--p= reallocation=3D@var{prealloc}] [-q] [--shrink] @var{filename} [+ | -]@var{s= ize} ETEXI =20 STEXI diff --git a/qemu-img.texi b/qemu-img.texi index adf5176902..2be8206a05 100644 --- a/qemu-img.texi +++ b/qemu-img.texi @@ -194,12 +194,12 @@ Command description: =20 @table @option =20 -@item amend [-p] [-f @var{fmt}] [-t @var{cache}] -o @var{options} @var{fil= ename} +@item amend [--object @var{objectdef}] [--image-opts] [-p] [-p] [-f @var{f= mt}] [-t @var{cache}] -o @var{options} @var{filename} =20 Amends the image format specific @var{options} for the image file @var{filename}. Not all file formats support this operation. =20 -@item bench [-c @var{count}] [-d @var{depth}] [-f @var{fmt}] [--flush-inte= rval=3D@var{flush_interval}] [-n] [--no-drain] [-o @var{offset}] [--pattern= =3D@var{pattern}] [-q] [-s @var{buffer_size}] [-S @var{step_size}] [-t @var= {cache}] [-w] @var{filename} +@item bench [-c @var{count}] [-d @var{depth}] [-f @var{fmt}] [--flush-inte= rval=3D@var{flush_interval}] [-n] [--no-drain] [-o @var{offset}] [--pattern= =3D@var{pattern}] [-q] [-s @var{buffer_size}] [-S @var{step_size}] [-t @var= {cache}] [-w] [-U] @var{filename} =20 Run a simple sequential I/O benchmark on the specified image. If @code{-w}= is specified, a write test is performed, otherwise a read test is performed. @@ -223,7 +223,7 @@ specified as well. For write tests, by default a buffer filled with zeros is written. This ca= n be overridden with a pattern byte specified by @var{pattern}. =20 -@item check [-f @var{fmt}] [--output=3D@var{ofmt}] [-r [leaks | all]] [-T = @var{src_cache}] @var{filename} +@item check [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}] = [--output=3D@var{ofmt}] [-r [leaks | all]] [-T @var{src_cache}] [-U] @var{f= ilename} =20 Perform a consistency check on the disk image @var{filename}. The command = can output in the format @var{ofmt} which is either @code{human} or @code{json= }. @@ -259,7 +259,7 @@ If @code{-r} is specified, exit codes representing the = image state refer to the state after (the attempt at) repairing it. That is, a successful @code{-r = all} will yield the exit code 0, independently of the image state before. =20 -@item commit [-q] [-f @var{fmt}] [-t @var{cache}] [-b @var{base}] [-d] [-p= ] @var{filename} +@item commit [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}]= [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} =20 Commit the changes recorded in @var{filename} in its base image or backing= file. If the backing file is smaller than the snapshot, then the backing file wi= ll be @@ -281,7 +281,7 @@ all images between @var{base} and the top image will be= invalid and may return garbage data when read. For this reason, @code{-b} implies @code{-d} (so t= hat the top image stays valid). =20 -@item compare [-f @var{fmt}] [-F @var{fmt}] [-T @var{src_cache}] [-p] [-s]= [-q] @var{filename1} @var{filename2} +@item compare [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [-F= @var{fmt}] [-T @var{src_cache}] [-p] [-q] [-s] [-U] @var{filename1} @var{f= ilename2} =20 Check if two images have the same content. You can compare images with different format or settings. @@ -322,7 +322,7 @@ Error on reading data =20 @end table =20 -@item convert [-c] [-p] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_= cache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o @var{options}] [-= s @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-m @var{num_corouti= nes}] [-W] [-S @var{sparse_size}] @var{filename} [@var{filename2} [...]] @v= ar{output_filename} +@item convert [--object @var{objectdef}] [--image-opts] [--target-image-op= ts] [-U] [-c] [-p] [-q] [-n] [-f @var{fmt}] [-t @var{cache}] [-T @var{src_c= ache}] [-O @var{output_fmt}] [-B @var{backing_file}] [-o @var{options}] [-s= @var{snapshot_id_or_name}] [-l @var{snapshot_param}] [-S @var{sparse_size}= ] [-m @var{num_coroutines}] [-W] @var{filename} [@var{filename2} [...]] @va= r{output_filename} =20 Convert the disk image @var{filename} or a snapshot @var{snapshot_param}(@= var{snapshot_id_or_name} is deprecated) to disk image @var{output_filename} using format @var{output_fmt}. It can = be optionally compressed (@code{-c} @@ -363,7 +363,7 @@ creating compressed images. @var{num_coroutines} specifies how many coroutines work in parallel during the convert process (defaults to 8). =20 -@item create [-f @var{fmt}] [-b @var{backing_file}] [-F @var{backing_fmt}]= [-u] [-o @var{options}] @var{filename} [@var{size}] +@item create [--object @var{objectdef}] [-q] [-f @var{fmt}] [-b @var{backi= ng_file}] [-F @var{backing_fmt}] [-u] [-o @var{options}] @var{filename} [@v= ar{size}] =20 Create the new disk image @var{filename} of size @var{size} and format @var{fmt}. Depending on the file format, you can add one or more @var{opti= ons} @@ -387,7 +387,7 @@ way. The size can also be specified using the @var{size} option with @code{-o}, it doesn't need to be specified separately in this case. =20 -@item dd [-f @var{fmt}] [-O @var{output_fmt}] [bs=3D@var{block_size}] [cou= nt=3D@var{blocks}] [skip=3D@var{blocks}] if=3D@var{input} of=3D@var{output} +@item dd [--image-opts] [-U] [-f @var{fmt}] [-O @var{output_fmt}] [bs=3D@v= ar{block_size}] [count=3D@var{blocks}] [skip=3D@var{blocks}] if=3D@var{inpu= t} of=3D@var{output} =20 Dd copies from @var{input} file to @var{output} file converting it from @var{fmt} format to @var{output_fmt} format. @@ -398,7 +398,7 @@ dd will stop reading input after reading @var{blocks} i= nput blocks. =20 The size syntax is similar to dd(1)'s size syntax. =20 -@item info [-f @var{fmt}] [--output=3D@var{ofmt}] [--backing-chain] @var{f= ilename} +@item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--out= put=3D@var{ofmt}] [--backing-chain] [-U] @var{filename} =20 Give information about the disk image @var{filename}. Use it in particular to know the size reserved on disk which can be different @@ -506,11 +506,11 @@ been written to all sectors. This is the maximum siz= e that the image file can occupy with the exception of internal snapshots, dirty bitmaps, vmstate da= ta, and other advanced image format features. =20 -@item snapshot [-l | -a @var{snapshot} | -c @var{snapshot} | -d @var{snaps= hot} ] @var{filename} +@item snapshot [--object @var{objectdef}] [--image-opts] [-U] [-q] [-l | -= a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} =20 List, apply, create or delete snapshots in image @var{filename}. =20 -@item rebase [-f @var{fmt}] [-t @var{cache}] [-T @var{src_cache}] [-p] [-u= ] -b @var{backing_file} [-F @var{backing_fmt}] @var{filename} +@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} =20 Changes the backing file of an image. Only the formats @code{qcow2} and @code{qed} support changing the backing file. @@ -570,7 +570,7 @@ qemu-img rebase -b base.img diff.qcow2 At this point, @code{modified.img} can be discarded, since @code{base.img + diff.qcow2} contains the same information. =20 -@item resize [--shrink] [--preallocation=3D@var{prealloc}] @var{filename} = [+ | -]@var{size} +@item resize [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--p= reallocation=3D@var{prealloc}] [-q] [--shrink] @var{filename} [+ | -]@var{s= ize} =20 Change the disk image as if it had been created with @var{size}. =20 --=20 2.14.3