From nobody Mon Feb 9 22:39:00 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1579883377; cv=none; d=zohomail.com; s=zohoarc; b=hvtCa6Rj1SQs3cOh2UHNmlw38eN0YzedUAG95dgKCuC1JPZ7vnTP02ew9G5wcrtjUuIGbkejqo8MuBDByVd8n27aG+QVTALciATsV3P8UXmukdzh9zz/N4dQiqapOur95A5FYbmrFBulGePBUSBh8AFEWMG9k68II7HkhgaiYRs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1579883377; h=Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=YF+2ATjXHISPE7K09rBXUt1UUGl3PdwL5/J+X4aqnNs=; b=GNX+Kz0TIyRqP/x1LyTYaMbW2HLdsBXCu4ZxSqtt22xWPYzlmVsd7ZxHAYAkZYjJjeOxXSG01qPW7/kUEb4hkVtEACDIUr1ApJJk90F7PP20e2R6xk7DHea/l2eTyKZWQmg4u40HbX7Bwvi7VROBdByAmA1Xsmm0zfXHqYCTpPU= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1579883377773951.4684180044824; Fri, 24 Jan 2020 08:29:37 -0800 (PST) Received: from localhost ([::1]:44492 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iv1pw-0000WR-OT for importer@patchew.org; Fri, 24 Jan 2020 11:29:36 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:37965) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iv1mm-0002bk-2N for qemu-devel@nongnu.org; Fri, 24 Jan 2020 11:26:21 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iv1mk-0002sp-BT for qemu-devel@nongnu.org; Fri, 24 Jan 2020 11:26:19 -0500 Received: from mail-wr1-x42f.google.com ([2a00:1450:4864:20::42f]:45787) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iv1mk-0002qM-5Y for qemu-devel@nongnu.org; Fri, 24 Jan 2020 11:26:18 -0500 Received: by mail-wr1-x42f.google.com with SMTP id j42so2664573wrj.12 for ; Fri, 24 Jan 2020 08:26:18 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id q3sm7054998wmj.38.2020.01.24.08.26.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 24 Jan 2020 08:26:14 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=YF+2ATjXHISPE7K09rBXUt1UUGl3PdwL5/J+X4aqnNs=; b=KJ+JAySorBoBbZPK/56fjF+3Wg+qkPWRfKNUM4WAIHT0tX+/DVtOz/yp3R4/lZGJhL h7ua3gktDKwMXz3icF/1I0ensAskFn30wtT4CfaW8tMT0AeztSSRd8SBq5RxAKANDwDr R8xLeHRWymAyLrA4LgXTmK5qN7L2s7z6xht9UAVxu8nxyvDMGo/uYZlnfBdgc4eYLkWQ 17ju212eA1mJ2UFv41XpMDONyzsbO6mUoF4IFWTdnU5YZrpY3xwuwxyj53JQrvCGK6A2 ghDCe8rtP6mFtYKZArPUbnZH8utC+VW/pSESvdImcwoMc+hj8gKVDDRb5RVW5J4UxWCa j8xQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=YF+2ATjXHISPE7K09rBXUt1UUGl3PdwL5/J+X4aqnNs=; b=aGOfyE73gS1BQAyFDjQGZ7LYMWB4mp8RuQfCbGwXWWmOwa2Jro9UScOgl8+8xf+2R2 UuWSvBX5uYA5LwDKiOVQ8QIDnm+ab9BnTr3uiAWHlGBVuCtnwbfRcAQ7mhYxumJhSLEu vKWB0Rzwm6tErL9rovvzw1vJYvO02J6z0hbCxbF6gWpA0xOggTy60goxGnPiubQfKjKx h0T0ZG5FrIJExT+O/1Ko/b0ZBG5ApnDoabYRB3eadgI/IgzqMAa7gXKGoLnqdVgP78br GY9qJHZVPvMdsCF7l+nPIH9yXWCzWUaAVALzrqS2D6+6a12HvnG9J1ocMMjU1twsy8Wa E1SQ== X-Gm-Message-State: APjAAAUs81Q6rgzUMMvv1/qdaNh55n8WDha24IxNdjEFOOHTy4NE/bXC 3Ag9O6rl59kj9rYbzjwaG0jvYev2KinwUg== X-Google-Smtp-Source: APXvYqzp48481YsRuoRh7FjpSBvmFNHQbIft/Tq1qpMd49WZJx/jI/JK4NIcZh+cvsy8pOrY2PBgGQ== X-Received: by 2002:a5d:62c8:: with SMTP id o8mr5152963wrv.316.1579883175350; Fri, 24 Jan 2020 08:26:15 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH v2 4/8] qemu-img-cmds.hx: Add rST documentation fragments Date: Fri, 24 Jan 2020 16:26:02 +0000 Message-Id: <20200124162606.8787-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200124162606.8787-1-peter.maydell@linaro.org> References: <20200124162606.8787-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::42f X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Kevin Wolf , qemu-block@nongnu.org, Markus Armbruster , Richard Henderson , Greg Kurz , Max Reitz , Stefan Hajnoczi , John Snow Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" 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 Reviewed-by: Richard Henderson --- 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{f= mt}] [-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 =20 DEF("bench", img_bench, "bench [-c count] [-d depth] [-f fmt] [--flush-interval=3Dflush_interv= al] [-n] [--no-drain] [-o offset] [--pattern=3Dpattern] [-q] [-s buffer_siz= e] [-S step_size] [-t cache] [-w] [-U] filename") STEXI @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} ETEXI - +SRST +.. option:: bench [-c COUNT] [-d DEPTH] [-f FMT] [--flush-interval=3DFLUSH= _INTERVAL] [-n] [--no-drain] [-o OFFSET] [--pattern=3DPATTERN] [-q] [-s BUF= FER_SIZE] [-S STEP_SIZE] [-t CACHE] [-w] [-U] FILENAME +ERST DEF("check", img_check, "check [--object objectdef] [--image-opts] [-q] [-f fmt] [--output=3Do= fmt] [-r [leaks | all]] [-T src_cache] [-U] filename") STEXI @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} ETEXI +SRST +.. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--out= put=3DOFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME +ERST =20 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 C= ACHE] [-b BASE] [-d] [-p] FILENAME +ERST =20 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{f= ilename2} ETEXI +SRST +.. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] = [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2 +ERST =20 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_fm= t] [-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-op= ts] [-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_filen= ame} ETEXI +SRST +.. option:: convert [--object OBJECTDEF] [--image-opts] [--target-image-op= ts] [-U] [-C] [-c] [-p] [-q] [-n] [-f FMT] [-t CACHE] [-T SRC_CACHE] [-O OU= TPUT_FMT] [-B BACKING_FILE] [-o OPTIONS] [-l SNAPSHOT_PARAM] [-S SPARSE_SIZ= E] [-m NUM_COROUTINES] [-W] [--salvage] FILENAME [FILENAME2 [...]] OUTPUT_F= ILENAME +ERST =20 DEF("create", img_create, "create [--object objectdef] [-q] [-f fmt] [-b backing_file] [-F backi= ng_fmt] [-u] [-o options] filename [size]") STEXI @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}] ETEXI +SRST +.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE] [-= F BACKING_FMT] [-u] [-o OPTIONS] FILENAME [SIZE] +ERST =20 DEF("dd", img_dd, "dd [--image-opts] [-U] [-f fmt] [-O output_fmt] [bs=3Dblock_size] [co= unt=3Dblocks] [skip=3Dblocks] if=3Dinput of=3Doutput") STEXI @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} ETEXI +SRST +.. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=3DBLOCK_SI= ZE] [count=3DBLOCKS] [skip=3DBLOCKS] if=3DINPUT of=3DOUTPUT +ERST =20 DEF("info", img_info, "info [--object objectdef] [--image-opts] [-f fmt] [--output=3Dofmt] [= --backing-chain] [-U] filename") STEXI @item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--out= put=3D@var{ofmt}] [--backing-chain] [-U] @var{filename} ETEXI +SRST +.. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=3D= OFMT] [--backing-chain] [-U] FILENAME +ERST =20 DEF("map", img_map, "map [--object objectdef] [--image-opts] [-f fmt] [--output=3Dofmt] [-= U] filename") STEXI @item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--outp= ut=3D@var{ofmt}] [-U] @var{filename} ETEXI +SRST +.. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=3DO= FMT] [-U] FILENAME +ERST =20 DEF("measure", img_measure, "measure [--output=3Dofmt] [-O output_fmt] [-o options] [--size N | [--obj= ect objectdef] [--image-opts] [-f fmt] [-l snapshot_param] filename]") STEXI @item measure [--output=3D@var{ofmt}] [-O @var{output_fmt}] [-o @var{optio= ns}] [--size @var{N} | [--object @var{objectdef}] [--image-opts] [-f @var{f= mt}] [-l @var{snapshot_param}] @var{filename}] ETEXI +SRST +.. option:: measure [--output=3DOFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size= N | [--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILEN= AME] +ERST =20 DEF("snapshot", img_snapshot, "snapshot [--object objectdef] [--image-opts] [-U] [-q] [-l | -a snaps= hot | -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 =20 DEF("rebase", img_rebase, "rebase [--object objectdef] [--image-opts] [-U] [-q] [-f fmt] [-t cac= he] [-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] FILENA= ME +ERST =20 DEF("resize", img_resize, "resize [--object objectdef] [--image-opts] [-f fmt] [--preallocation= =3Dprealloc] [-q] [--shrink] filename [+ | -]size") STEXI @item resize [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--p= reallocation=3D@var{prealloc}] [-q] [--shrink] @var{filename} [+ | -]@var{s= ize} ETEXI +SRST +.. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallo= cation=3DPREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE +ERST =20 STEXI @end table --=20 2.20.1