From nobody Sun May 19 02:26:43 2024 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=1579633956; cv=none; d=zohomail.com; s=zohoarc; b=RUAf/VjKDcucA6OxggvaCzXiD7RhtsMqZTQ8+IztbqwRTMJhEfjvZjvTziLJhjGahGE11sC+5faACo2npd+ByZMZ5Ek0dHN3DPaJFX4CbNyuaca284GO1KIsZu+VfveRXWqDn9RcHWyuPKDZKBe8U1stVAQsG2D46s+zjLhJjzg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1579633956; 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=OZwxrhVFppo0vboz/j9HZKWFBkmFicMobpa/s3rMNnE=; b=hagibdbZ1Ny8lGpZgelIT64cEtW+W4KgvYIGMgAcB6ovYYJ3Jq3/bS6pMEM0tSp7/3fqzqnVpKFi/GqmkS8yl3j0LXfKJQXXu2AZs6UPrWE2qphCNImvm9OSiGRzof/ppm6GWfc0mYoF/cGN0AoryxFuudJCLYarUJnbZI8tscg= 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 1579633956899278.1061404242938; Tue, 21 Jan 2020 11:12:36 -0800 (PST) Received: from localhost ([::1]:59902 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityx1-0004Ez-3L for importer@patchew.org; Tue, 21 Jan 2020 14:12:35 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59236) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityvA-0002Jf-Md for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:41 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ityv9-0004PF-E9 for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:40 -0500 Received: from mail-wr1-x444.google.com ([2a00:1450:4864:20::444]:45486) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ityv9-0004Or-80 for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:39 -0500 Received: by mail-wr1-x444.google.com with SMTP id j42so4518258wrj.12 for ; Tue, 21 Jan 2020 11:10:39 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id l3sm49533271wrt.29.2020.01.21.11.10.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Jan 2020 11:10:37 -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=OZwxrhVFppo0vboz/j9HZKWFBkmFicMobpa/s3rMNnE=; b=hbaqs1rTQiRnvoCB0CHT1LLY8R99sDptJ20S8i0ScWCYKPmsnB/11qTquzol0wpeLL q6jSSbJF3fJKdyl7YQ8DZyK6v5h+I3vVEQZUx4FaDZtMINryCvu+eZwHJLKMfcyPX7Uq UogZ/NGW3lek8ccU2xsa/nhxQyysPgLSVFeHGO6PwjXuHhvzqo3x6E7CPag4qYGjYMCn H4XZRxmglJQdFEEOuhozHiI6dBrjT0U/mVAPRhP44lZNcgInzp/5fzSRV8KNvdkZSxhD /suXZS4mu6B2aMQXwgk54QCwHCA2moXiFHyWmygFK/wgd19g3CG+UvqWWEgyP7ikx/GV UOSg== 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=OZwxrhVFppo0vboz/j9HZKWFBkmFicMobpa/s3rMNnE=; b=Lv2ZP08HY/Dwp4EWEvA7wmyLhkJ2DI+qGcenp+WM2K6qvE+5oTUVJKumzq54xgHYKb vVIXX/rBXyWPNQnfzGpCM36qwKqD0fAjWbiGbH2uRmso5sHrDYVy1gRJIRmUKhWe3XKs 0W0K4G4NrAD2UKB8RySThTF/kGI2Vcshv0DgdGEG5mXj8KXST90x4iQON2D1p9N45H4l lc0lKbn5DRGY9VmZbYmHj69MjXo1wbPok4bhnZu/yBGpM6o7IEcUMC8Xj7VPaBpp3H/X 1D5+zThCzPHZojUq07f6hspALw630qBJfYaE1mslW5IEy/eyXkcXl5j7vfWBiz4a5UvA d+GQ== X-Gm-Message-State: APjAAAU+1Mt/B9UUtmBIfFDtW0qhhdew91WF5PGJEHwim2W/sXaxqSF1 j9xyNnBffoMgwer+JW4WiAco+i2M4U8J2w== X-Google-Smtp-Source: APXvYqzXr/GKzHqavdcRoAi+uCoNU4Wq3/c/OXE2ZBLliFdu+S6Hb8UiPfOoh6C+LNZQhzLN9PyEhw== X-Received: by 2002:adf:f605:: with SMTP id t5mr6491666wrp.282.1579633838063; Tue, 21 Jan 2020 11:10:38 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH 1/5] hxtool: Support SRST/ERST directives Date: Tue, 21 Jan 2020 19:10:29 +0000 Message-Id: <20200121191033.28195-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200121191033.28195-1-peter.maydell@linaro.org> References: <20200121191033.28195-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::444 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 , 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" We want to add support for including rST document fragments in our .hx files, in the same way we currently have texinfo fragments. These will be delimited by SRST and ERST directives, in the same way the texinfo is delimited by STEXI/ETEXI. The rST fragments will not be extracted by the hxtool script, but by a different mechanism, so all we need to do in hxtool is have it ignore all the text inside a SRST/ERST section, with suitable error-checking for mismatched rST-vs-texi fragment delimiters. The resulting effective state machine has only three states: * flag =3D 0, rstflag =3D 0 : reading section for C output * flag =3D 1, rstflag =3D 0 : reading texi fragment * flag =3D 0, rstflag =3D 1 : reading rST fragment and flag =3D 1, rstflag =3D 1 is not possible. Using two variables makes the parallel between the rST handling and the texi handling clearer; in any case all this code will be deleted once we've converted entirely to rST. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson --- scripts/hxtool | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/scripts/hxtool b/scripts/hxtool index 7d7c4289e32..0003e7b673d 100644 --- a/scripts/hxtool +++ b/scripts/hxtool @@ -7,7 +7,7 @@ hxtoh() case $str in HXCOMM*) ;; - STEXI*|ETEXI*) flag=3D$(($flag^1)) + STEXI*|ETEXI*|SRST*|ERST*) flag=3D$(($flag^1)) ;; *) test $flag -eq 1 && printf "%s\n" "$str" @@ -27,12 +27,17 @@ print_texi_heading() hxtotexi() { flag=3D0 + rstflag=3D0 line=3D1 while read -r str; do case "$str" in HXCOMM*) ;; STEXI*) + if test $rstflag -eq 1 ; then + printf "line %d: syntax error: expected ERST, found '%s'\n= " "$line" "$str" >&2 + exit 1 + fi if test $flag -eq 1 ; then printf "line %d: syntax error: expected ETEXI, found '%s'\= n" "$line" "$str" >&2 exit 1 @@ -40,12 +45,38 @@ hxtotexi() flag=3D1 ;; ETEXI*) + if test $rstflag -eq 1 ; then + printf "line %d: syntax error: expected ERST, found '%s'\n= " "$line" "$str" >&2 + exit 1 + fi if test $flag -ne 1 ; then printf "line %d: syntax error: expected STEXI, found '%s'\= n" "$line" "$str" >&2 exit 1 fi flag=3D0 ;; + SRST*) + if test $rstflag -eq 1 ; then + printf "line %d: syntax error: expected ERST, found '%s'\n= " "$line" "$str" >&2 + exit 1 + fi + if test $flag -eq 1 ; then + printf "line %d: syntax error: expected ETEXI, found '%s'\= n" "$line" "$str" >&2 + exit 1 + fi + rstflag=3D1 + ;; + ERST*) + if test $flag -eq 1 ; then + printf "line %d: syntax error: expected ETEXI, found '%s'\= n" "$line" "$str" >&2 + exit 1 + fi + if test $rstflag -ne 1 ; then + printf "line %d: syntax error: expected SRST, found '%s'\n= " "$line" "$str" >&2 + exit 1 + fi + rstflag=3D0 + ;; DEFHEADING*) print_texi_heading "$(expr "$str" : "DEFHEADING(\(.*\))")" ;; --=20 2.20.1 From nobody Sun May 19 02:26:43 2024 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=1579634035; cv=none; d=zohomail.com; s=zohoarc; b=cApEWSxqnwNZNff7C3Ofw8wl8LcSoSxzjebUG/PaSEsP0taDXVlS8mgVkGzZzB1iiXghVp8sAQ0TxOwze0F0wDnqbTYoaR9RLbZ8WmvgLKC4JCj7OpYt+HUvT1mUgGO1/8KmmTkvk5uE2NT6Qo2ix/TdWGr7C/cYEL9RMScX3fg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1579634035; 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=db5e6be7O4HKfAHCOU8w21vQ7ctBVgPLwPnDNpl0o0o=; b=i9mJNBShHsFR6+yjqwG44ifVkKn7PoVnRdJNgSU4CJcwKhyaorUnqMn5NQwWRSZZY17hlZdQAdT5Ns9rBGL3MlEtmj93nK22iAOttLmAMdVKYMdCo+M4QosIzuqPUR3IaQcNSTAaAcm6Z0ezSqtdvHgZuwcHYVC1/uuGHzLoenY= 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 1579634035198243.74968717728552; Tue, 21 Jan 2020 11:13:55 -0800 (PST) Received: from localhost ([::1]:59916 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityyH-0005vY-BP for importer@patchew.org; Tue, 21 Jan 2020 14:13:53 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59268) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityvD-0002MT-0g for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:45 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ityvA-0004Qf-VD for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:42 -0500 Received: from mail-wm1-x332.google.com ([2a00:1450:4864:20::332]:53175) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ityvA-0004Pl-OO for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:40 -0500 Received: by mail-wm1-x332.google.com with SMTP id p9so4177079wmc.2 for ; Tue, 21 Jan 2020 11:10:40 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id l3sm49533271wrt.29.2020.01.21.11.10.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Jan 2020 11:10:38 -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=db5e6be7O4HKfAHCOU8w21vQ7ctBVgPLwPnDNpl0o0o=; b=Sd0eXXWBdM59UbNf5Ebuu3mPZvkFjwWH0ynaamZQR6mInAhFwicXM5m/Vp0iV4LwL2 SH1tzDcF0/JL3oKgydnNGBcKB6mzmu0etvcpVOc4ms8JePv+9A4YTDBRbcoLI18RPOox oGXWvih8TnNefN1hWshjfOKi6ATgdA6QVlqgUXpUmHSSGlrfNXrlf/xfxTyelYim8sIf pncgh76NfA9tz0eapKNBQwYTcMIf6wxv4QqLFoZwGHA5djsmyDs6+E/S0qUKAPFKpSSW C2EjMJQOCmcNAS70BOyoXoYCHgmDf9/q1hbEIdBI8SDS9NftobTFfDSVNi0wV1PCEhOn 5Elw== 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=db5e6be7O4HKfAHCOU8w21vQ7ctBVgPLwPnDNpl0o0o=; b=OQ1lmE2fmcgw3eRZdyfc3TX5UY2xPSWAH6Pp1vRz4DaeQZoRvmvRWI0mA67xGEQm3H +3IQRjeind96v/0aF3HafzYnqpfPXrcRx61RgkfA2YN8a21HfZWiXa2dYjxU+dX/YOhP FZuP9wIx0em3qgid+EBnM0XczdXPga8XwSmrVHXCAK6XCblu37y3THBpjIgbrT+9zf0g WUCYCFkFzacWG/d9Hd7ZsJXyH39fcUNbm6ovcV1G8z0sEKBJQHE9c/bWXQu97QwFa+7V llsMi/fX2Fpp96jXjLqUkVB/wzbn0q7XLG1KM0EQBudOIncDVxWTZulPVim4rypr+kX6 nkCQ== X-Gm-Message-State: APjAAAUh9GTniqVPE/ncwTYNIsdVCQAbbl2TL3cTbRZqPOwqGaUUaDib MaAVo04TBNVTXj1I7X44hZlOqwvqKRbAbw== X-Google-Smtp-Source: APXvYqwGADVkbEjFB2hMAueLmWM7ekajYyazwJ+EPSBlCjpw/a4/g61BZstU5j8gdelPDaso32DZGQ== X-Received: by 2002:a7b:c750:: with SMTP id w16mr14746wmk.46.1579633839397; Tue, 21 Jan 2020 11:10:39 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH 2/5] docs/sphinx: Add new hxtool Sphinx extension Date: Tue, 21 Jan 2020 19:10:30 +0000 Message-Id: <20200121191033.28195-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200121191033.28195-1-peter.maydell@linaro.org> References: <20200121191033.28195-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::332 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 , 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" Some of our documentation includes sections which are created by assembling fragments of texinfo from a .hx source file into a .texi file, which is then included from qemu-doc.texi or qemu-img.texi. For Sphinx, rather than creating a file to include, the most natural way to handle this is to have a small custom Sphinx extension which reads the .hx file and process it. So instead of: * makefile produces foo.texi from foo.hx * qemu-doc.texi says '@include foo.texi' we have: * qemu-doc.rst says 'hxtool-doc:: foo.hx' * the Sphinx extension for hxtool has code that runs to handle that Sphinx directive which reads the .hx file and emits the appropriate documentation contents This is pretty much the same way the kerneldoc extension works right now. It also has the advantage that it should work for third-party services like readthedocs that expect to build the docs directly with sphinx rather than by invoking our makefiles. In this commit we implement the hxtool extension. Note that syntax errors in the rST fragments will be correctly reported to the user with the filename and line number within the hx file. Signed-off-by: Peter Maydell --- docs/conf.py | 3 +- docs/sphinx/hxtool.py | 210 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 212 insertions(+), 1 deletion(-) create mode 100644 docs/sphinx/hxtool.py diff --git a/docs/conf.py b/docs/conf.py index 259c6049da7..ee7faa6b4e7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -54,7 +54,7 @@ needs_sphinx =3D '1.3' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions =3D ['kerneldoc', 'qmp_lexer'] +extensions =3D ['kerneldoc', 'qmp_lexer', 'hxtool'] =20 # Add any paths that contain templates here, relative to this directory. templates_path =3D ['_templates'] @@ -221,3 +221,4 @@ texinfo_documents =3D [ # find everything. kerneldoc_bin =3D os.path.join(qemu_docdir, '../scripts/kernel-doc') kerneldoc_srctree =3D os.path.join(qemu_docdir, '..') +hxtool_srctree =3D os.path.join(qemu_docdir, '..') diff --git a/docs/sphinx/hxtool.py b/docs/sphinx/hxtool.py new file mode 100644 index 00000000000..417cb10ece7 --- /dev/null +++ b/docs/sphinx/hxtool.py @@ -0,0 +1,210 @@ +# coding=3Dutf-8 +# +# QEMU hxtool .hx file parsing extension +# +# Copyright (c) 2020 Linaro +# +# This work is licensed under the terms of the GNU GPLv2 or later. +# See the COPYING file in the top-level directory. +"""hxtool is a Sphinx extension that implements the hxtool-doc directive""" + +# The purpose of this extension is to read fragments of rST +# from .hx files, and insert them all into the current document. +# The rST fragments are delimited by SRST/ERST lines. +# The conf.py file must set the hxtool_srctree config value to +# the root of the QEMU source tree. +# Each hxtool-doc:: directive takes one argument which is the +# path of the .hx file to process, relative to the source tree. + +import os +import re +from enum import Enum + +from docutils import nodes +from docutils.statemachine import ViewList +from docutils.parsers.rst import directives, Directive +from sphinx.application import ExtensionError +from sphinx.util.nodes import nested_parse_with_titles +import sphinx + +# Sphinx up to 1.6 uses AutodocReporter; 1.7 and later +# use switch_source_input. Check borrowed from kerneldoc.py. +Use_SSI =3D sphinx.__version__[:3] >=3D '1.7' +if Use_SSI: + from sphinx.util.docutils import switch_source_input +else: + from sphinx.ext.autodoc import AutodocReporter + +__version__ =3D '1.0' + +# We parse hx files with a state machine which may be in one of three +# states: reading the C code fragment, inside a texi fragment, +# or inside a rST fragment. +class HxState(Enum): + CTEXT =3D 1 + TEXI =3D 2 + RST =3D 3 + +def serror(file, lnum, errtext): + """Raise an exception giving a user-friendly syntax error message""" + raise ExtensionError('%s line %d: syntax error: %s' % (file, lnum, err= text)) + +def parse_directive(line): + """Return first word of line, if any""" + return re.split('\W', line)[0] + +def parse_defheading(file, lnum, line): + """Handle a DEFHEADING directive""" + # The input should be "DEFHEADING(some string)", though note that + # the 'some string' could be the empty string. If the string is + # empty we ignore the directive -- these are used only to add + # blank lines in the plain-text content of the --help output. + # + # Return the heading text + match =3D re.match(r'DEFHEADING\((.*)\)', line) + if match is None: + serror(file, lnum, "Invalid DEFHEADING line") + return match.group(1) + +def parse_archheading(file, lnum, line): + """Handle an ARCHHEADING directive""" + # The input should be "ARCHHEADING(some string, other arg)", + # though note that the 'some string' could be the empty string. + # As with DEFHEADING, empty string ARCHHEADINGs will be ignored. + # + # Return the heading text + match =3D re.match(r'ARCHHEADING\((.*),.*\)', line) + if match is None: + serror(file, lnum, "Invalid ARCHHEADING line") + return match.group(1) + +class HxtoolDocDirective(Directive): + """Extract rST fragments from the specified .hx file""" + required_argument =3D 1 + optional_arguments =3D 1 + option_spec =3D { + 'hxfile': directives.unchanged_required + } + has_content =3D False + + def run(self): + env =3D self.state.document.settings.env + hxfile =3D env.config.hxtool_srctree + '/' + self.arguments[0] + + # Tell sphinx of the dependency + env.note_dependency(os.path.abspath(hxfile)) + + state =3D HxState.CTEXT + # We build up lines of rST in this ViewList, which we will + # later put into a 'section' node. + rstlist =3D ViewList() + current_node =3D None + node_list =3D [] + + with open(hxfile) as f: + lines =3D (l.rstrip() for l in f) + for lnum, line in enumerate(lines, 1): + directive =3D parse_directive(line) + + if directive =3D=3D 'HXCOMM': + pass + elif directive =3D=3D 'STEXI': + if state =3D=3D HxState.RST: + serror(hxfile, lnum, 'expected ERST, found STEXI') + elif state =3D=3D HxState.TEXI: + serror(hxfile, lnum, 'expected ETEXI, found STEXI') + else: + state =3D HxState.TEXI + elif directive =3D=3D 'ETEXI': + if state =3D=3D HxState.RST: + serror(hxfile, lnum, 'expected ERST, found ETEXI') + elif state =3D=3D HxState.CTEXT: + serror(hxfile, lnum, 'expected STEXI, found ETEXI') + else: + state =3D HxState.CTEXT + elif directive =3D=3D 'SRST': + if state =3D=3D HxState.RST: + serror(hxfile, lnum, 'expected ERST, found SRST') + elif state =3D=3D HxState.TEXI: + serror(hxfile, lnum, 'expected ETEXI, found SRST') + else: + state =3D HxState.RST + elif directive =3D=3D 'ERST': + if state =3D=3D HxState.TEXI: + serror(hxfile, lnum, 'expected ETEXI, found ERST') + elif state =3D=3D HxState.CTEXT: + serror(hxfile, lnum, 'expected SRST, found ERST') + else: + state =3D HxState.CTEXT + elif directive =3D=3D 'DEFHEADING' or directive =3D=3D 'AR= CHHEADING': + if directive =3D=3D 'DEFHEADING': + heading =3D parse_defheading(hxfile, lnum, line) + else: + heading =3D parse_archheading(hxfile, lnum, line) + if heading =3D=3D "": + continue + # Put the accumulated rST into the previous node, + # and then start a fresh section with this heading. + if len(rstlist) > 0: + if current_node is None: + # We had some rST fragments before the first + # DEFHEADING. We don't have a section to put + # these in, so rather than magicing up a secti= on, + # make it a syntax error. + serror(hxfile, lnum, + 'first DEFHEADING must precede all rST = text') + self.do_parse(rstlist, current_node) + rstlist =3D ViewList() + if current_node is not None: + node_list.append(current_node) + section_id =3D 'hxtool-%d' % env.new_serialno('hxtool') + current_node =3D nodes.section(ids=3D[section_id]) + current_node +=3D nodes.title(heading, heading) + else: + # Not a directive: put in output if we are in rST frag= ment + if state =3D=3D HxState.RST: + # Sphinx counts its lines from 0 + rstlist.append(line, hxfile, lnum - 1) + + if current_node is None: + # We don't have multiple sections, so just parse the rst + # fragments into a dummy node so we can return the children. + current_node =3D nodes.section() + self.do_parse(rstlist, current_node) + return current_node.children + else: + # Put the remaining accumulated rST into the last section, and + # return all the sections. + if len(rstlist) > 0: + self.do_parse(rstlist, current_node) + node_list.append(current_node) + return node_list + + # This is from kerneldoc.py -- it works around an API change in + # Sphinx between 1.6 and 1.7. Unlike kerneldoc.py, we use + # sphinx.util.nodes.nested_parse_with_titles() rather than the + # plain self.state.nested_parse(), and so we can drop the saving + # of title_styles and section_level that kerneldoc.py does, + # because nested_parse_with_titles() does that for us. + def do_parse(self, result, node): + if Use_SSI: + with switch_source_input(self.state, result): + nested_parse_with_titles(self.state, result, node) + else: + save =3D self.state.memo.reporter + self.state.memo.reporter =3D AutodocReporter(result, self.stat= e.memo.reporter) + try: + nested_parse_with_titles(self.state, result, node) + finally: + self.state.memo.reporter =3D save + +def setup(app): + """ Register hxtool-doc directive with Sphinx""" + app.add_config_value('hxtool_srctree', None, 'env') + app.add_directive('hxtool-doc', HxtoolDocDirective) + + return dict( + version =3D __version__, + parallel_read_safe =3D True, + parallel_write_safe =3D True + ) --=20 2.20.1 From nobody Sun May 19 02:26:43 2024 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=1579634125; cv=none; d=zohomail.com; s=zohoarc; b=Net71rpmz8TOowdSL752ZJusVHeOLuIj5oa18O+0qyV0egrrB6I5ffOLxyQO3px/ZI05CjKSPHbGQghBoua7/yxT+hOpACt5rK0tLZHdSry4gLXZO7nSU6I9PTzR/mERCIDVhAOKAnaAZxHBPzzicpy26l1YRREmL3+lH7Hr+d8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1579634125; 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=YgQN1p9Mj8l0yOXTe1E+j+etT2oiKZkymYR7RkNpVuE=; b=hhrMS/hsfT20+/mmkqp29VTQ2dRL/RXpQvlWtK3Rl5PntiXLklLzqXqBwd3AyIdmVvko1leSDhizXSmY4JLfEEE5pXbQ64LgdgC4HfzHN68yG/KR9M0Ay4zqvY1zksG6Cxf3mzC83ZHePTMZ6JV9v5wHIRruA3iN4fjO1RCzO6c= 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 1579634125420429.20202595584146; Tue, 21 Jan 2020 11:15:25 -0800 (PST) Received: from localhost ([::1]:59960 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityzj-00089g-PQ for importer@patchew.org; Tue, 21 Jan 2020 14:15:23 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59278) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityvD-0002Ne-Na for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:45 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ityvC-0004RD-0W for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:43 -0500 Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]:53620) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ityvB-0004Qt-Qi for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:41 -0500 Received: by mail-wm1-x32e.google.com with SMTP id m24so4167472wmc.3 for ; Tue, 21 Jan 2020 11:10:41 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id l3sm49533271wrt.29.2020.01.21.11.10.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Jan 2020 11:10:40 -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=YgQN1p9Mj8l0yOXTe1E+j+etT2oiKZkymYR7RkNpVuE=; b=oOGvc3PvTIIxs68ou108HZzVL1ltTUFkGwaGgGhVjIVCEYDJB/44pCkpZDt56IqCYn GrkXze6JElw+EuYFUFH/5LPI3xjWKveRYxfC8QJGyWm/voZNK+fQ7NTOF8yVeSGtFnlm FgpzIobBlVvnuwlUp4TRo8o3ntNzrqpXxJE651ITgXNTEHCCWwLELfLUR5KH/fDLU+Zd zEWzxAucxsJtNRqWjd9waZ9yYKTtnHGSoO+pq90IUoEolc6mWnGHIHMzyos69kBoo6RQ Zw4xMEHo8UmJyHS8hPNitjJyHdvglQi3Jo7dYbTRWtv8SA++ExFW2pnY10tooOZ8Stq1 8wJA== 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=YgQN1p9Mj8l0yOXTe1E+j+etT2oiKZkymYR7RkNpVuE=; b=hhzp7L0M3R3DQGnyBHgwby2RvgHFoU7Vn8ZERFc839Nn/HG9RBcXfbW2fti/rAANGm EpXKscPAQHZ45bnJhujcctglLY7qGRyXXIaUHuhwH/SqvLambC8+OUd+rAV6mzhAuA8k LPMNJPmPI/ybT3qCHnBf4cER1zzxzRZq/7SMEpQs3Oxn/i2NMqnrYdk0QKSB/C3asO/J djAVRqjFVNXJDFWEYsT3pvUrDGMuRFwfy1A80ozup6ausB7jPNS2H7QkkEEhmqXeRAZ4 GHsdtQ2hgGSncSD20n59dRc5P/mxyuwccwQ3BEdyUySM/8aP20KhGDM0yUuiX7ZPQBYX fp8w== X-Gm-Message-State: APjAAAWyo8C/y6ehNF3rSzUr8bSu7f//zooZ/I3PSvejWjMweaIH01qe o8qWxySAoUG7QU8hPtdUFwoS2k5RFyjobA== X-Google-Smtp-Source: APXvYqyD11NpixC6En3EcOH6g4m4ArqAj6OZJwYbxqgnw8kqF+knp+6Az5WWha5fXeUyOcKwZs0w8g== X-Received: by 2002:a7b:c759:: with SMTP id w25mr5575992wmk.15.1579633840559; Tue, 21 Jan 2020 11:10:40 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH 3/5] qemu-img-cmds.hx: Add rST documentation fragments Date: Tue, 21 Jan 2020 19:10:31 +0000 Message-Id: <20200121191033.28195-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200121191033.28195-1-peter.maydell@linaro.org> References: <20200121191033.28195-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::32e 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 , 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 From nobody Sun May 19 02:26:43 2024 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=1579634253; cv=none; d=zohomail.com; s=zohoarc; b=H9aMlpqTlVFd7DnsABo2gO/sqsB5XIKDrHmDWn/Q4mEsscX2cGkmdP/1BYG6M2YXQhhVXhpwjxc2OS6PUBQSgDjh4/SQV0GDjeaH4/sgU2ribhOhSfpjT2yxYzuK8GEiy3/Z0VNj3zQmSxFlO+ezNUKlVrNSaXonbolkXKsog1w= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1579634253; 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=Fhk5BMarpC0GmZ+9C8oLdau6Sab1t1Z3cL128uDWUWQ=; b=myJZ1X7SvfHWi+S+diF9QRGPrq9M4/gkxrM5+1dPA7sb4pba914evGMyvOPhi5LOs7wHgWuFNnbZtRM4Q0jjiCRcAqY0ctUZqoklD8RmMua5Kbz5m4tRY0vOF28vszv6hgsdYdYzO1ZRy49v+deC77Cg6tSWkQsmrAUVgih0z+s= 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 1579634253765642.8301396669086; Tue, 21 Jan 2020 11:17:33 -0800 (PST) Received: from localhost ([::1]:60006 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1itz1o-0001si-F5 for importer@patchew.org; Tue, 21 Jan 2020 14:17:32 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59367) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityvP-0002i9-JB for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:11:04 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ityvH-0004Tb-9Z for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:55 -0500 Received: from mail-wm1-x344.google.com ([2a00:1450:4864:20::344]:52887) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ityvG-0004Sx-TG for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:47 -0500 Received: by mail-wm1-x344.google.com with SMTP id p9so4177387wmc.2 for ; Tue, 21 Jan 2020 11:10:46 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id l3sm49533271wrt.29.2020.01.21.11.10.40 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Jan 2020 11:10:42 -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=Fhk5BMarpC0GmZ+9C8oLdau6Sab1t1Z3cL128uDWUWQ=; b=v8z+oTW5Bsc6smb1FPT+KyvBIjV2qYxne1yEjB2LPNKkRIsxsXW6A2RKBiOYrF9gVO 1pqbMovpJfeRkqLeczH370S5ZKsHx4sA8FcIHCrTkXugZRZ3QfzIIV4OOFTJaYYJmJnG 5sFHLHJSiJW5t20NZcK2hs+QY91fJhP+L3TU9T8fOJn+90CtGyNx0n0nzzw2/VnIIBg9 /rIEe8Xp1uNo/XIBBtO0nmbbW5glxiFiCl6wfIPJ350Wc1q5gkA/cVgTdMETuT0it3Bp 3b/5isLR9D81tcNsvjC77RfuZ3rs9Sh/dZPNmHWlxd/9i49MCVAzkMm0DIUSH5nhv/y6 s7xg== 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=Fhk5BMarpC0GmZ+9C8oLdau6Sab1t1Z3cL128uDWUWQ=; b=kNBWLli17ijE3xHW4ZEGJhD4H/EhUItv591Eu/qXCZ6axdBYMxeEdbS8w72Qf5o6v4 RlZj5nwK7oexADOByiz6ZaenINJztFYRLAsQD7oYICQxkT4+jYQwXxrhKU/msQvPJQBV JNL9qJL1YMh2x5pAbQKpAqn4l6SPyOHwZ7hlNG/Doc7OHvPDZVGLkheGcsG613KRIVc6 0LXBJJRNcN31ccjiJUcX5d1PhGR+XXXSBa5a0N4HcCOnk13/rlxfSQEgC/2/5uWYDzGF mQNGdIx1pTXEoapSDQK97Hl8QQv3wduXj3bBIZsHqt8oDvaCukNmCCpTqBr8a6WVPCPF 4bTA== X-Gm-Message-State: APjAAAWh1UZZPkqySjLuAJJ8MQEljqf7ZQXsDfi9XypCBLUuu9Iz+u8g OmPgMOBIf7urBc2wmdS6mCqgG8ccWOL4Cg== X-Google-Smtp-Source: APXvYqxvYoM0LRT1tzA2wvVhHvZE1oTeK8SXY6xGdAMgPfE1UZ6mOEdhiLuCZPGYxgW5QzREpNbpRg== X-Received: by 2002:a7b:cfc2:: with SMTP id f2mr18576wmm.44.1579633843033; Tue, 21 Jan 2020 11:10:43 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH 4/5] qemu-img: Convert invocation documentation to rST Date: Tue, 21 Jan 2020 19:10:32 +0000 Message-Id: <20200121191033.28195-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200121191033.28195-1-peter.maydell@linaro.org> References: <20200121191033.28195-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::344 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 , 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" The qemu-img documentation is currently in qemu-nbd.texi in Texinfo format, which we present to the user as: * a qemu-img manpage * a section of the main qemu-doc HTML documentation Convert the documentation to rST format, and present it to the user as: * a qemu-img manpage * part of the interop/ Sphinx manual The qemu-img rST document uses the new hxtool extension to handle pulling rST fragments out of qemu-img-cmds.hx. The documentation of the various options and commands is rather muddled, with some options being described inside the relevant command description and some in a more general section near the start of the manual. All the command synopses are replicated in the .hx file and then again in the manual. A lot of text is also duplicated in the qemu-img.c code for the help text. I have not attempted to deal with any of this, but have simply transposed the existing structure into rST. As usual, there are some minor formatting changes but no textual changes, except that as with one or two other conversions I have dropped the 'see also' section since it's not very informative and looks odd in the HTML. Signed-off-by: Peter Maydell --- The eagle-eyed will notice that I have not attempted to create a real linked reference to the 'QEMU block drivers reference documentation'; this is a bit tricky since it's (at least sometimes) in a different Sphinx manual to this document. I opted to leave this sort of nicety for later rather than hold up the process of conversion. --- Makefile | 19 +- MAINTAINERS | 1 + docs/interop/conf.py | 2 + docs/interop/index.rst | 1 + docs/interop/qemu-img.rst | 822 ++++++++++++++++++++++++++++++++++++++ qemu-doc.texi | 10 +- qemu-img.texi | 795 ------------------------------------ 7 files changed, 839 insertions(+), 811 deletions(-) create mode 100644 docs/interop/qemu-img.rst delete mode 100644 qemu-img.texi diff --git a/Makefile b/Makefile index 318d1046c6c..6d508345f36 100644 --- a/Makefile +++ b/Makefile @@ -339,7 +339,8 @@ MANUAL_BUILDDIR :=3D docs endif =20 ifdef BUILD_DOCS -DOCS=3Dqemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 +DOCS=3Dqemu-doc.html qemu-doc.txt qemu.1 +DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-img.1 DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-nbd.8 DOCS+=3D$(MANUAL_BUILDDIR)/interop/qemu-ga.8 DOCS+=3D$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 @@ -732,7 +733,7 @@ rm -f $(MANUAL_BUILDDIR)/$1/objects.inv $(MANUAL_BUILDD= IR)/$1/searchindex.js $(M endef =20 distclean: clean - rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.= texi qemu-img-cmds.texi qemu-monitor.texi qemu-monitor-info.texi + rm -f config-host.mak config-host.h* config-host.ld $(DOCS) qemu-options.= texi qemu-monitor.texi qemu-monitor-info.texi rm -f tests/tcg/config-*.mak rm -f config-all-devices.mak config-all-disas.mak config.status rm -f $(SUBDIR_DEVICES_MAK) @@ -830,7 +831,7 @@ ifdef CONFIG_POSIX $(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR= )$(mandir)/man7" $(INSTALL_DATA) docs/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7" ifeq ($(CONFIG_TOOLS),y) - $(INSTALL_DATA) qemu-img.1 "$(DESTDIR)$(mandir)/man1" + $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-img.1 "$(DESTDIR)$(mandir= )/man1" $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8" $(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-nbd.8 "$(DESTDIR)$(mandir= )/man8" endif @@ -1032,6 +1033,10 @@ $(MANUAL_BUILDDIR)/system/index.html: $(call manual-= deps,system) $(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop) $(call build-manual,interop,man) =20 +$(MANUAL_BUILDDIR)/interop/qemu-img.1: $(call manual-deps,interop) \ + $(SRC_PATH)/qemu-img-cmds.hx + $(call build-manual,interop,man) + $(MANUAL_BUILDDIR)/interop/qemu-nbd.8: $(call manual-deps,interop) $(call build-manual,interop,man) =20 @@ -1051,9 +1056,6 @@ qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx $(SRC_= PATH)/scripts/hxtool qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/scrip= ts/hxtool $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@= ") =20 -qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/scripts/hxtool - $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@,"GEN","$@= ") - docs/interop/qemu-qmp-qapi.texi: qapi/qapi-doc.texi @cp -p $< $@ =20 @@ -1062,7 +1064,6 @@ docs/interop/qemu-ga-qapi.texi: qga/qapi-generated/qg= a-qapi-doc.texi =20 qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-inf= o.texi qemu.1: qemu-option-trace.texi -qemu-img.1: qemu-img.texi qemu-option-trace.texi qemu-img-cmds.texi fsdev/virtfs-proxy-helper.1: fsdev/virtfs-proxy-helper.texi docs/qemu-cpu-models.7: docs/qemu-cpu-models.texi scripts/qemu-trace-stap.1: scripts/qemu-trace-stap.texi @@ -1073,9 +1074,9 @@ pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/= interop/qemu-ga-ref.pdf txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.t= xt =20 qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \ - qemu-img.texi qemu-options.texi \ + qemu-options.texi \ qemu-tech.texi qemu-option-trace.texi \ - qemu-deprecated.texi qemu-monitor.texi qemu-img-cmds.texi \ + qemu-deprecated.texi qemu-monitor.texi \ qemu-monitor-info.texi \ docs/qemu-cpu-models.texi docs/security.texi =20 diff --git a/MAINTAINERS b/MAINTAINERS index 44de95b890f..af8de5707ff 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1825,6 +1825,7 @@ F: block/ F: hw/block/ F: include/block/ F: qemu-img* +F: docs/interop/qemu-img.rst F: qemu-io* F: tests/qemu-iotests/ F: util/qemu-progress.c diff --git a/docs/interop/conf.py b/docs/interop/conf.py index 40b1ad811de..0de444a900d 100644 --- a/docs/interop/conf.py +++ b/docs/interop/conf.py @@ -19,6 +19,8 @@ html_theme_options['description'] =3D u'System Emulation = Management and Interopera man_pages =3D [ ('qemu-ga', 'qemu-ga', u'QEMU Guest Agent', ['Michael Roth '], 8), + ('qemu-img', 'qemu-img', u'QEMU disk image utility', + ['Fabrice Bellard'], 1), ('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server', ['Anthony Liguori '], 8) ] diff --git a/docs/interop/index.rst b/docs/interop/index.rst index c28f7785a55..5e4de07d4cc 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -18,6 +18,7 @@ Contents: live-block-operations pr-helper qemu-ga + qemu-img qemu-nbd vhost-user vhost-user-gpu diff --git a/docs/interop/qemu-img.rst b/docs/interop/qemu-img.rst new file mode 100644 index 00000000000..997a25a6d40 --- /dev/null +++ b/docs/interop/qemu-img.rst @@ -0,0 +1,822 @@ +QEMU disk image utility +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Synopsis +-------- + +**qemu-img** [*standard options*] *command* [*command options*] + +Description +----------- + +qemu-img allows you to create, convert and modify images offline. It can h= andle +all image formats supported by QEMU. + +**Warning:** Never use qemu-img to modify images in use by a running virtu= al +machine or any other process; this may destroy the image. Also, be aware t= hat +querying an image that is being modified by another process may encounter +inconsistent state. + +Options +------- + +.. program:: qemu-img + +Standard options: + +.. option:: -h, --help + + Display this help and exit + +.. option:: -V, --version + + Display version information and exit + +.. option:: -T, --trace [[enable=3D]PATTERN][,events=3DFILE][,file=3DFILE] + + .. include:: qemu-option-trace.rst.inc + +The following commands are supported: + +.. hxtool-doc:: qemu-img-cmds.hx + +Command parameters: + +*FILENAME* is a disk image filename. + +*FMT* is the disk image format. It is guessed automatically in most +cases. See below for a description of the supported disk formats. + +*SIZE* is the disk image size in bytes. Optional suffixes ``k`` or +``K`` (kilobyte, 1024) ``M`` (megabyte, 1024k) and ``G`` (gigabyte, +1024M) and T (terabyte, 1024G) are supported. ``b`` is ignored. + +*OUTPUT_FILENAME* is the destination disk image filename. + +*OUTPUT_FMT* is the destination format. + +*OPTIONS* is a comma separated list of format specific options in a +name=3Dvalue format. Use ``-o ?`` for an overview of the options supported +by the used format or see the format descriptions below for details. + +*SNAPSHOT_PARAM* is param used for internal snapshot, format is +'snapshot.id=3D[ID],snapshot.name=3D[NAME]' or '[ID_OR_NAME]'. + +.. + Note the use of a new 'program'; otherwise Sphinx complains about + the -h option appearing both in the above option list and this one. + +.. program:: qemu-img-common-opts + +.. option:: --object OBJECTDEF + + is a QEMU user creatable object definition. See the :manpage:`qemu(1)` + manual page for a description of the object properties. The most common + object type is a ``secret``, which is used to supply passwords and/or + encryption keys. + +.. option:: --image-opts + + Indicates that the source *FILENAME* parameter is to be interpreted as a + full option string, not a plain filename. This parameter is mutually + exclusive with the *-f* parameter. + +.. option:: --target-image-opts + + Indicates that the OUTPUT_FILENAME parameter(s) are to be interpreted as + a full option string, not a plain filename. This parameter is mutually + exclusive with the *-O* parameters. It is currently required to also use + the *-n* parameter to skip image creation. This restriction may be relax= ed + in a future release. + +.. option:: --force-share (-U) + + If specified, ``qemu-img`` will open the image in shared mode, allowing + other QEMU processes to open it in write mode. For example, this can be = used to + get the image information (with 'info' subcommand) when the image is use= d by a + running guest. Note that this could produce inconsistent results becaus= e of + concurrent metadata changes, etc. This option is only allowed when openi= ng + images in read-only mode. + +.. option:: --backing-chain + + Will enumerate information about backing files in a disk image chain. Re= fer + below for further description. + +.. option:: -c + + Indicates that target image must be compressed (qcow format only). + +.. option:: -h + + With or without a command, shows help and lists the supported formats. + +.. option:: -p + + Display progress bar (compare, convert and rebase commands only). + If the *-p* option is not used for a command that supports it, the + progress is reported when the process receives a ``SIGUSR1`` or + ``SIGINFO`` signal. + +.. option:: -q + + Quiet mode - do not print any output (except errors). There's no progres= s bar + in case both *-q* and *-p* options are used. + +.. 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 r= ounded + down to the nearest 512 bytes. You may use the common size suffixes like + ``k`` for kilobytes. + +.. option:: -t CACHE + + Specifies the cache mode that should be used with the (destination) file= . See + the documentation of the emulator's ``-drive cache=3D...`` option for al= lowed + values. + +.. option:: -T SRC_CACHE + + Specifies the cache mode that should be used with the source file(s). See + the documentation of the emulator's ``-drive cache=3D...`` option for al= lowed + values. + +Parameters to snapshot subcommand: + +.. program:: qemu-img-snapshot + +.. option:: snapshot + + Is the name of the snapshot to create, apply or delete + +.. option:: -a + + Applies a snapshot (revert disk to saved state) + +.. option:: -c + + Creates a snapshot + +.. option:: -d + + Deletes a snapshot + +.. option:: -l + + Lists all snapshots in the given image + +Parameters to compare subcommand: + +.. program:: qemu-img-compare + +.. option:: -f + + First image format + +.. option:: -F + + Second image format + +.. option:: -s + + Strict mode - fail on different image size or sector allocation + +Parameters to convert subcommand: + +.. program:: qemu-img-convert + +.. option:: -n + + Skip the creation of the target volume + +.. option:: -m + + Number of parallel coroutines for the convert process + +.. option:: -W + + Allow out-of-order writes to the destination. This option improves perfo= rmance, + but is only recommended for preallocated devices like host devices or ot= her + raw block devices. + +.. option:: -C + + Try to use copy offloading to move data from source image to target. Thi= s may + improve performance if the data is remote, such as with NFS or iSCSI bac= kends, + but will not automatically sparsify zero sectors, and may result in a fu= lly + allocated target image depending on the host support for getting allocat= ion + information. + +.. option:: --salvage + + Try to ignore I/O errors when reading. Unless in quiet mode (``-q``), e= rrors + will still be printed. Areas that cannot be read from the source will be + treated as containing only zeroes. + +Parameters to dd subcommand: + +.. program:: qemu-img-dd + +.. option:: bs=3DBLOCK_SIZE + + Defines the block size + +.. option:: count=3DBLOCKS + + Sets the number of input blocks to copy + +.. option:: if=3DINPUT + + Sets the input file + +.. option:: of=3DOUTPUT + + Sets the output file + +.. option:: skip=3DBLOCKS + + Sets the number of input blocks to skip + +Command description: + +.. program:: qemu-img-commands + +.. option:: amend [--object OBJECTDEF] [--image-opts] [-p] [-q] [-f FMT] [= -t CACHE] -o OPTIONS FILENAME + + Amends the image format specific *OPTIONS* for the image file + *FILENAME*. Not all file formats support this operation. + +.. 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 + + Run a simple sequential I/O benchmark on the specified image. If ``-w`` = is + specified, a write test is performed, otherwise a read test is performed. + + A total number of *COUNT* I/O requests is performed, each *BUFFER_SIZE* + bytes in size, and with *DEPTH* requests in parallel. The first request + starts at the position given by *OFFSET*, each following request increas= es + the current position by *STEP_SIZE*. If *STEP_SIZE* is not given, + *BUFFER_SIZE* is used for its value. + + If *FLUSH_INTERVAL* is specified for a write test, the request queue is + drained and a flush is issued before new writes are made whenever the nu= mber of + remaining requests is a multiple of *FLUSH_INTERVAL*. If additionally + ``--no-drain`` is specified, a flush is issued without draining the requ= est + queue first. + + If ``-n`` is specified, the native AIO backend is used if possible. On + Linux, this option only works if ``-t none`` or ``-t directsync`` is + specified as well. + + For write tests, by default a buffer filled with zeros is written. This = can be + overridden with a pattern byte specified by *PATTERN*. + +.. option:: check [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [--out= put=3DOFMT] [-r [leaks | all]] [-T SRC_CACHE] [-U] FILENAME + + Perform a consistency check on the disk image *FILENAME*. The command can + output in the format *OFMT* which is either ``human`` or ``json``. + The JSON output is an object of QAPI type ``ImageCheck``. + + If ``-r`` is specified, qemu-img tries to repair any inconsistencies fou= nd + during the check. ``-r leaks`` repairs only cluster leaks, whereas + ``-r all`` fixes all kinds of errors, with a higher risk of choosing the + wrong fix or hiding corruption that has already occurred. + + Only the formats ``qcow2``, ``qed`` and ``vdi`` support + consistency checks. + + In case the image does not have any inconsistencies, check exits with ``= 0``. + Other exit codes indicate the kind of inconsistency found or if another = error + occurred. The following table summarizes all exit codes of the check sub= command: + + 0 + Check completed, the image is (now) consistent + 1 + Check not completed because of internal errors + 2 + Check completed, image is corrupted + 3 + Check completed, image has leaked clusters, but is not corrupted + 63 + Checks are not supported by the image format + + If ``-r`` is specified, exit codes representing the image state refer to= the + state after (the attempt at) repairing it. That is, a successful ``-r al= l`` + will yield the exit code 0, independently of the image state before. + +.. option:: commit [--object OBJECTDEF] [--image-opts] [-q] [-f FMT] [-t C= ACHE] [-b BASE] [-d] [-p] FILENAME + + Commit the changes recorded in *FILENAME* in its base image or backing f= ile. + If the backing file is smaller than the snapshot, then the backing file = will be + resized to be the same size as the snapshot. If the snapshot is smaller= than + the backing file, the backing file will not be truncated. If you want t= he + backing file to match the size of the smaller snapshot, you can safely t= runcate + it yourself once the commit operation successfully completes. + + The image *FILENAME* is emptied after the operation has succeeded. If yo= u do + not need *FILENAME* afterwards and intend to drop it, you may skip empty= ing + *FILENAME* by specifying the ``-d`` flag. + + If the backing chain of the given image file *FILENAME* has more than one + layer, the backing file into which the changes will be committed may be + specified as *BASE* (which has to be part of *FILENAME*'s backing + chain). If *BASE* is not specified, the immediate backing file of the top + image (which is *FILENAME*) will be used. Note that after a commit opera= tion + all images between *BASE* and the top image will be invalid and may retu= rn + garbage data when read. For this reason, ``-b`` implies ``-d`` (so that + the top image stays valid). + +.. option:: compare [--object OBJECTDEF] [--image-opts] [-f FMT] [-F FMT] = [-T SRC_CACHE] [-p] [-q] [-s] [-U] FILENAME1 FILENAME2 + + Check if two images have the same content. You can compare images with + different format or settings. + + The format is probed unless you specify it by ``-f`` (used for + *FILENAME1*) and/or ``-F`` (used for *FILENAME2*) option. + + By default, images with different size are considered identical if the l= arger + image contains only unallocated and/or zeroed sectors in the area after = the end + of the other image. In addition, if any sector is not allocated in one i= mage + and contains only zero bytes in the second one, it is evaluated as equal= . You + can use Strict mode by specifying the ``-s`` option. When compare runs in + Strict mode, it fails in case image size differs or a sector is allocate= d in + one image and is not allocated in the second one. + + By default, compare prints out a result message. This message displays + information that both images are same or the position of the first diffe= rent + byte. In addition, result message can report different image size in case + Strict mode is used. + + Compare exits with ``0`` in case the images are equal and with ``1`` + in case the images differ. Other exit codes mean an error occurred during + execution and standard error output should contain an error message. + The following table sumarizes all exit codes of the compare subcommand: + + 0 + Images are identical + 1 + Images differ + 2 + Error on opening an image + 3 + Error on checking a sector allocation + 4 + Error on reading data + +.. 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] FILENAME [FILENAME2 [...]] OUTPUT_FILENAME + + Convert the disk image *FILENAME* or a snapshot *SNAPSHOT_PARAM* + to disk image *OUTPUT_FILENAME* using format *OUTPUT_FMT*. It can + be optionally compressed (``-c`` option) or use any format specific + options like encryption (``-o`` option). + + Only the formats ``qcow`` and ``qcow2`` support compression. The + compression is read-only. It means that if a compressed sector is + rewritten, then it is rewritten as uncompressed data. + + Image conversion is also useful to get smaller image when using a + growable format such as ``qcow``: the empty sectors are detected and + 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 + 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. + + You can use the *BACKING_FILE* option to force the output image to be + created as a copy on write image of the specified base image; the + *BACKING_FILE* should have the same content as the input's base image, + however the path, image format, etc may differ. + + If a relative path name is given, the backing file is looked up relative= to + the directory containing *OUTPUT_FILENAME*. + + 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. + + Out of order writes can be enabled with ``-W`` to improve performance. + This is only recommended for preallocated devices like host devices or o= ther + raw block devices. Out of order write does not work in combination with + creating compressed images. + + *NUM_COROUTINES* specifies how many coroutines work in parallel during + the convert process (defaults to 8). + +.. option:: create [--object OBJECTDEF] [-q] [-f FMT] [-b BACKING_FILE] [-= F BACKING_FMT] [-u] [-o OPTIONS] FILENAME [SIZE] + + Create the new disk image *FILENAME* of size *SIZE* and format + *FMT*. Depending on the file format, you can add one or more *OPTIONS* + that enable additional features of this format. + + 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). + + If a relative path name is given, the backing file is looked up relative= to + the directory containing *FILENAME*. + + Note that a given backing file will be opened to check that it is valid.= Use + the ``-u`` option to enable unsafe backing file mode, which means that t= he + image will be created even if the associated backing file cannot be open= ed. A + matching backing file must be created or additional options be used to m= ake the + backing file specification valid when you want to use an image created t= his + way. + + The size can also be specified using the *SIZE* option with ``-o``, + it doesn't need to be specified separately in this case. + + +.. option:: dd [--image-opts] [-U] [-f FMT] [-O OUTPUT_FMT] [bs=3DBLOCK_SI= ZE] [count=3DBLOCKS] [skip=3DBLOCKS] if=3DINPUT of=3DOUTPUT + + dd copies from *INPUT* file to *OUTPUT* file converting it from + *FMT* format to *OUTPUT_FMT* format. + + The data is by default read and written using blocks of 512 bytes but ca= n be + modified by specifying *BLOCK_SIZE*. If count=3D\ *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. + +.. option:: info [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=3D= OFMT] [--backing-chain] [-U] FILENAME + + Give information about the disk image *FILENAME*. Use it in + particular to know the size reserved on disk which can be different + from the displayed size. If VM snapshots are stored in the disk image, + they are displayed too. + + If a disk image has a backing file chain, information about each disk im= age in + the chain can be recursively enumerated by using the option ``--backing-= chain``. + + For instance, if you have an image chain like: + + :: + + base.qcow2 <- snap1.qcow2 <- snap2.qcow2 + + To enumerate information about each disk image in the above chain, start= ing from top to base, do: + + :: + + qemu-img info --backing-chain snap2.qcow2 + + The command can output in the format *OFMT* which is either ``human`` or + ``json``. The JSON output is an object of QAPI type ``ImageInfo``; with + ``--backing-chain``, it is an array of ``ImageInfo`` objects. + + ``--output=3Dhuman`` reports the following information (for every image = in the + chain): + + *image* + The image file name + + *file format* + The image format + + *virtual size* + The size of the guest disk + + *disk size* + How much space the image file occupies on the host file system (may be + shown as 0 if this information is unavailable, e.g. because there is no + file system) + + *cluster_size* + Cluster size of the image format, if applicable + + *encrypted* + Whether the image is encrypted (only present if so) + + *cleanly shut down* + This is shown as ``no`` if the image is dirty and will have to be + auto-repaired the next time it is opened in qemu. + + *backing file* + The backing file name, if present + + *backing file format* + The format of the backing file, if the image enforces it + + *Snapshot list* + A list of all internal snapshots + + *Format specific information* + Further information whose structure depends on the image format. This + section is a textual representation of the respective + ``ImageInfoSpecific*`` QAPI object (e.g. ``ImageInfoSpecificQCow2`` + for qcow2 images). + +.. option:: map [--object OBJECTDEF] [--image-opts] [-f FMT] [--output=3DO= FMT] [-U] FILENAME + + Dump the metadata of image *FILENAME* and its backing file chain. + In particular, this commands dumps the allocation state of every sector + of *FILENAME*, together with the topmost file that allocates it in + the backing file chain. + + Two option formats are possible. The default format (``human``) + only dumps known-nonzero areas of the file. Known-zero parts of the + file are omitted altogether, and likewise for parts that are not allocat= ed + throughout the chain. ``qemu-img`` output will identify a file + from where the data can be read, and the offset in the file. Each line + will include four fields, the first three of which are hexadecimal + numbers. For example the first line of: + + :: + + Offset Length Mapped to File + 0 0x20000 0x50000 /tmp/overlay.qcow2 + 0x100000 0x10000 0x95380000 /tmp/backing.qcow2 + + means that 0x20000 (131072) bytes starting at offset 0 in the image are + available in /tmp/overlay.qcow2 (opened in ``raw`` format) starting + at offset 0x50000 (327680). Data that is compressed, encrypted, or + otherwise not available in raw format will cause an error if ``human`` + format is in use. Note that file names can include newlines, thus it is + not safe to parse this output format in scripts. + + The alternative format ``json`` will return an array of dictionaries + in JSON format. It will include similar information in + the ``start``, ``length``, ``offset`` fields; + it will also include other more specific information: + + - whether the sectors contain actual data or not (boolean field ``data``; + if false, the sectors are either unallocated or stored as optimized + all-zero clusters); + - whether the data is known to read as zero (boolean field ``zero``); + - in order to make the output shorter, the target file is expressed as + a ``depth``; for example, a depth of 2 refers to the backing file + of the backing file of *FILENAME*. + + In JSON format, the ``offset`` field is optional; it is absent in + cases where ``human`` format would omit the entry or exit with an error. + If ``data`` is false and the ``offset`` field is present, the + corresponding sectors in the file are not yet in use, but they are + preallocated. + + For more information, consult ``include/block/block.h`` in QEMU's + source code. + +.. option:: measure [--output=3DOFMT] [-O OUTPUT_FMT] [-o OPTIONS] [--size= N | [--object OBJECTDEF] [--image-opts] [-f FMT] [-l SNAPSHOT_PARAM] FILEN= AME] + + Calculate the file size required for a new image. This information + can be used to size logical volumes or SAN LUNs appropriately for + the image that will be placed in them. The values reported are + guaranteed to be large enough to fit the image. The command can + output in the format *OFMT* which is either ``human`` or ``json``. + The JSON output is an object of QAPI type ``BlockMeasureInfo``. + + If the size *N* is given then act as if creating a new empty image file + using ``qemu-img create``. If *FILENAME* is given then act as if + converting an existing image file using ``qemu-img convert``. The format + of the new file is given by *OUTPUT_FMT* while the format of an existing + file is given by *FMT*. + + A snapshot in an existing image can be specified using *SNAPSHOT_PARAM*. + + The following fields are reported: + + :: + + required size: 524288 + fully allocated size: 1074069504 + + The ``required size`` is the file size of the new image. It may be smal= ler + than the virtual disk size if the image format supports compact represen= tation. + + The ``fully allocated size`` is the file size of the new image once data= has + been written to all sectors. This is the maximum size that the image fi= le can + occupy with the exception of internal snapshots, dirty bitmaps, vmstate = data, + and other advanced image format features. + +.. option:: snapshot [--object OBJECTDEF] [--image-opts] [-U] [-q] [-l | -= a SNAPSHOT | -c SNAPSHOT | -d SNAPSHOT] FILENAME + + List, apply, create or delete snapshots in image *FILENAME*. + +.. 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 + + Changes the backing file of an image. Only the formats ``qcow2`` and + ``qed`` support changing the backing file. + + The backing file is changed to *BACKING_FILE* and (if the image format of + *FILENAME* supports this) the backing file format is changed to + *BACKING_FMT*. If *BACKING_FILE* is specified as "" (the empty + string), then the image is rebased onto no backing file (i.e. it will ex= ist + independently of any backing file). + + If a relative path name is given, the backing file is looked up relative= to + the directory containing *FILENAME*. + + *CACHE* specifies the cache mode to be used for *FILENAME*, whereas + *SRC_CACHE* specifies the cache mode for reading backing files. + + There are two different modes in which ``rebase`` can operate: + + 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 + will take care of keeping the guest-visible content of *FILENAME* + unchanged. + + In order to achieve this, any clusters that differ between + *BACKING_FILE* and the old backing file of *FILENAME* are merged + into *FILENAME* before actually changing the backing file. + + Note that the safe mode is an expensive operation, comparable to + converting an image. It only works if the old backing file still + exists. + + Unsafe mode + 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 + content of the image will be corrupted. + + This mode is useful for renaming or moving the backing file to + somewhere else. It can be used without an accessible old backing + file, i.e. you can use it to fix an image whose backing file has + already been moved/renamed. + + You can use ``rebase`` to perform a "diff" operation on two + disk images. This can be useful when you have copied or cloned + a guest, and you want to get back to a thin image on top of a + template or base image. + + Say that ``base.img`` has been cloned as ``modified.img`` by + copying it, and that the ``modified.img`` guest has run so there + are now some changes compared to ``base.img``. To construct a thin + image called ``diff.qcow2`` that contains just the differences, do: + + :: + + qemu-img create -f qcow2 -b modified.img diff.qcow2 + qemu-img rebase -b base.img diff.qcow2 + + At this point, ``modified.img`` can be discarded, since + ``base.img + diff.qcow2`` contains the same information. + +.. option:: resize [--object OBJECTDEF] [--image-opts] [-f FMT] [--preallo= cation=3DPREALLOC] [-q] [--shrink] FILENAME [+ | -]SIZE + + Change the disk image as if it had been created with *SIZE*. + + Before using this command to shrink a disk image, you MUST use file syst= em and + partitioning tools inside the VM to reduce allocated file systems and pa= rtition + sizes accordingly. Failure to do so will result in data loss! + + When shrinking images, the ``--shrink`` option must be given. This infor= ms + 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 + partitioning tools inside the VM to actually begin using the new space o= n the + device. + + When growing an image, the ``--preallocation`` option may be used to spe= cify + how the additional image area should be allocated on the host. See the = format + description in the :ref:`notes` section which values are allowed. Using= this + option may result in slightly more data being allocated than necessary. + +.. _notes: + +Notes +----- + +Supported image file formats: + +``raw`` + + Raw disk image format (default). 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. + + Supported options: + + ``preallocation`` + Preallocation mode (allowed values: ``off``, ``falloc``, + ``full``). ``falloc`` mode preallocates space for image by + calling ``posix_fallocate()``. ``full`` mode preallocates space + for image by writing data to underlying storage. This data may or + may not be zero, depending on the storage location. + +``qcow2`` + + QEMU image format, the most versatile format. Use it to have smaller + images (useful if your filesystem does not supports holes, for example + on Windows), optional AES encryption, zlib based compression and + support of multiple VM snapshots. + + Supported options: + + ``compat`` + Determines the qcow2 version to use. ``compat=3D0.10`` uses the + traditional image format that can be read by any QEMU since 0.10. + ``compat=3D1.1`` enables image format extensions that only QEMU 1.1 and + newer understand (this is the default). Amongst others, this includes = zero + clusters, which allow efficient copy-on-read for sparse images. + + ``backing_file`` + File name of a base image (see ``create`` subcommand) + + ``backing_fmt`` + Image format of the base image + + ``encryption`` + If this option is set to ``on``, the image is encrypted with + 128-bit AES-CBC. + + The use of encryption in qcow and qcow2 images is considered to be + flawed by modern cryptography standards, suffering from a number + of design problems: + + - The AES-CBC cipher is used with predictable initialization + vectors based on the sector number. This makes it vulnerable to + chosen plaintext attacks which can reveal the existence of + encrypted data. + + - The user passphrase is directly used as the encryption key. A + poorly chosen or short passphrase will compromise the security + of the encryption. + + - In the event of the passphrase being compromised there is no way + to change the passphrase to protect data in any qcow images. The + files must be cloned, using a different encryption passphrase in + the new file. The original file must then be securely erased + using a program like shred, though even this is ineffective with + many modern storage technologies. + + - Initialization vectors used to encrypt sectors are based on the + guest virtual sector number, instead of the host physical + sector. When a disk image has multiple internal snapshots this + means that data in multiple physical sectors is encrypted with + the same initialization vector. With the CBC mode, this opens + the possibility of watermarking attacks if the attack can + collect multiple sectors encrypted with the same IV and some + predictable data. Having multiple qcow2 images with the same + passphrase also exposes this weakness since the passphrase is + directly used as the key. + + Use of qcow / qcow2 encryption is thus strongly discouraged. Users are + recommended to use an alternative encryption technology such as the + Linux dm-crypt / LUKS system. + + ``cluster_size`` + Changes the qcow2 cluster size (must be between 512 and + 2M). Smaller cluster sizes can improve the image file size whereas + larger cluster sizes generally provide better performance. + + ``preallocation`` + Preallocation mode (allowed values: ``off``, ``metadata``, + ``falloc``, ``full``). An image with preallocated metadata is + initially larger but can improve performance when the image needs + to grow. ``falloc`` and ``full`` preallocations are like the same + options of ``raw`` format, but sets up metadata also. + + ``lazy_refcounts`` + If this option is set to ``on``, reference count updates are + postponed with the goal of avoiding metadata I/O and improving + performance. This is particularly interesting with + ``cache=3Dwritethrough`` which doesn't batch metadata + updates. The tradeoff is that after a host crash, the reference + count tables must be rebuilt, i.e. on the next open an (automatic) + ``qemu-img check -r all`` is required, which may take some time. + + This option can only be enabled if ``compat=3D1.1`` is specified. + + ``nocow`` + If this option is set to ``on``, it will turn off COW of the file. It's + only valid on btrfs, no effect on other file systems. + + Btrfs has low performance when hosting a VM image file, even more + when the guest on the VM also using btrfs as file system. Turning + off COW is a way to mitigate this bad performance. Generally there + are two ways to turn off COW on btrfs: + + - Disable it by mounting with nodatacow, then all newly created files + will be NOCOW + - For an empty file, add the NOCOW file attribute. That's what this + option does. + + Note: this option is only valid to new or empty files. If there is + an existing file which is COW and has data blocks already, it + couldn't be changed to NOCOW by setting ``nocow=3Don``. One can + issue ``lsattr filename`` to check if the NOCOW flag is set or not + (Capital 'C' is NOCOW flag). + +``Other`` + + QEMU also supports various other image file formats for + compatibility with older QEMU versions or other hypervisors, + including VMDK, VDI, VHD (vpc), VHDX, qcow1 and QED. For a full list + of supported formats see ``qemu-img --help``. For a more detailed + description of these formats, see the QEMU block drivers reference + documentation. + + The main purpose of the block drivers for these formats is image + conversion. For running VMs, it is recommended to convert the disk + images to either raw or qcow2 in order to achieve good performance. diff --git a/qemu-doc.texi b/qemu-doc.texi index 2328e7ea476..f2e8d401b0f 100644 --- a/qemu-doc.texi +++ b/qemu-doc.texi @@ -632,7 +632,6 @@ encrypted disk images. * disk_images_quickstart:: Quick start for disk image creation * disk_images_snapshot_mode:: Snapshot mode * vm_snapshots:: VM snapshots -* qemu_img_invocation:: qemu-img Invocation @end menu =20 @node disk_images_quickstart @@ -646,7 +645,9 @@ where @var{myimage.img} is the disk image filename and = @var{mysize} is its size in kilobytes. You can add an @code{M} suffix to give the size in megabytes and a @code{G} suffix for gigabytes. =20 -See @ref{qemu_img_invocation} for more information. +@c When this document is converted to rst we should make this into +@c a proper linked reference to the qemu-img documentation again: +See the qemu-img invocation documentation for more information. =20 @node disk_images_snapshot_mode @subsection Snapshot mode @@ -708,11 +709,6 @@ A few device drivers still have incomplete snapshot su= pport so their state is not saved or restored properly (in particular USB). @end itemize =20 -@node qemu_img_invocation -@subsection @code{qemu-img} Invocation - -@include qemu-img.texi - @node pcsys_network @section Network emulation =20 diff --git a/qemu-img.texi b/qemu-img.texi deleted file mode 100644 index b5156d63168..00000000000 --- a/qemu-img.texi +++ /dev/null @@ -1,795 +0,0 @@ -@example -@c man begin SYNOPSIS -@command{qemu-img} [@var{standard} @var{options}] @var{command} [@var{comm= and} @var{options}] -@c man end -@end example - -@c man begin DESCRIPTION -qemu-img allows you to create, convert and modify images offline. It can h= andle -all image formats supported by QEMU. - -@b{Warning:} Never use qemu-img to modify images in use by a running virtu= al -machine or any other process; this may destroy the image. Also, be aware t= hat -querying an image that is being modified by another process may encounter -inconsistent state. -@c man end - -@c man begin OPTIONS - -Standard options: -@table @option -@item -h, --help -Display this help and exit -@item -V, --version -Display version information and exit -@item -T, --trace [[enable=3D]@var{pattern}][,events=3D@var{file}][,file= =3D@var{file}] -@findex --trace -@include qemu-option-trace.texi -@end table - -The following commands are supported: - -@include qemu-img-cmds.texi - -Command parameters: -@table @var - -@item filename -is a disk image filename - -@item fmt -is the disk image format. It is guessed automatically in most cases. See b= elow -for a description of the supported disk formats. - -@item size -is the disk image size in bytes. Optional suffixes @code{k} or @code{K} -(kilobyte, 1024) @code{M} (megabyte, 1024k) and @code{G} (gigabyte, 1024M) -and T (terabyte, 1024G) are supported. @code{b} is ignored. - -@item output_filename -is the destination disk image filename - -@item output_fmt -is the destination format - -@item options -is a comma separated list of format specific options in a -name=3Dvalue format. Use @code{-o ?} for an overview of the options suppor= ted -by the used format or see the format descriptions below for details. - -@item snapshot_param -is param used for internal snapshot, format is -'snapshot.id=3D[ID],snapshot.name=3D[NAME]' or '[ID_OR_NAME]' - -@end table - -@table @option - -@item --object @var{objectdef} -is a QEMU user creatable object definition. See the @code{qemu(1)} manual -page for a description of the object properties. The most common object -type is a @code{secret}, which is used to supply passwords and/or encrypti= on -keys. - -@item --image-opts -Indicates that the source @var{filename} parameter is to be interpreted as= a -full option string, not a plain filename. This parameter is mutually -exclusive with the @var{-f} parameter. - -@item --target-image-opts -Indicates that the @var{output_filename} parameter(s) are to be interprete= d as -a full option string, not a plain filename. This parameter is mutually -exclusive with the @var{-O} parameters. It is currently required to also u= se -the @var{-n} parameter to skip image creation. This restriction may be rel= axed -in a future release. - -@item --force-share (-U) -If specified, @code{qemu-img} will open the image in shared mode, allowing -other QEMU processes to open it in write mode. For example, this can be us= ed to -get the image information (with 'info' subcommand) when the image is used = by a -running guest. Note that this could produce inconsistent results because = of -concurrent metadata changes, etc. This option is only allowed when opening -images in read-only mode. - -@item --backing-chain -will enumerate information about backing files in a disk image chain. Refer -below for further description. - -@item -c -indicates that target image must be compressed (qcow format only) - -@item -h -with or without a command shows help and lists the supported formats - -@item -p -display progress bar (compare, convert and rebase commands only). -If the @var{-p} option is not used for a command that supports it, the -progress is reported when the process receives a @code{SIGUSR1} or -@code{SIGINFO} signal. - -@item -q -Quiet mode - do not print any output (except errors). There's no progress = bar -in case both @var{-q} and @var{-p} options are used. - -@item -S @var{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 rou= nded -down to the nearest 512 bytes. You may use the common size suffixes like -@code{k} for kilobytes. - -@item -t @var{cache} -specifies the cache mode that should be used with the (destination) file. = See -the documentation of the emulator's @code{-drive cache=3D...} option for a= llowed -values. - -@item -T @var{src_cache} -specifies the cache mode that should be used with the source file(s). See -the documentation of the emulator's @code{-drive cache=3D...} option for a= llowed -values. - -@end table - -Parameters to snapshot subcommand: - -@table @option - -@item snapshot -is the name of the snapshot to create, apply or delete -@item -a -applies a snapshot (revert disk to saved state) -@item -c -creates a snapshot -@item -d -deletes a snapshot -@item -l -lists all snapshots in the given image -@end table - -Parameters to compare subcommand: - -@table @option - -@item -f -First image format -@item -F -Second image format -@item -s -Strict mode - fail on different image size or sector allocation -@end table - -Parameters to convert subcommand: - -@table @option - -@item -n -Skip the creation of the target volume -@item -m -Number of parallel coroutines for the convert process -@item -W -Allow out-of-order writes to the destination. This option improves perform= ance, -but is only recommended for preallocated devices like host devices or other -raw block devices. -@item -C -Try to use copy offloading to move data from source image to target. This = may -improve performance if the data is remote, such as with NFS or iSCSI backe= nds, -but will not automatically sparsify zero sectors, and may result in a fully -allocated target image depending on the host support for getting allocation -information. -@item --salvage -Try to ignore I/O errors when reading. Unless in quiet mode (@code{-q}), = errors -will still be printed. Areas that cannot be read from the source will be -treated as containing only zeroes. -@end table - -Parameters to dd subcommand: - -@table @option - -@item bs=3D@var{block_size} -defines the block size -@item count=3D@var{blocks} -sets the number of input blocks to copy -@item if=3D@var{input} -sets the input file -@item of=3D@var{output} -sets the output file -@item skip=3D@var{blocks} -sets the number of input blocks to skip -@end table - -Command description: - -@table @option - -@item amend [--object @var{objectdef}] [--image-opts] [-p] [-q] [-f @var{f= mt}] [-t @var{cache}] -o @var{options} @var{filename} - -Amends the image format specific @var{options} for the image file -@var{filename}. Not all file formats support this operation. - -@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} - -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. - -A total number of @var{count} I/O requests is performed, each @var{buffer_= size} -bytes in size, and with @var{depth} requests in parallel. The first request -starts at the position given by @var{offset}, each following request incre= ases -the current position by @var{step_size}. If @var{step_size} is not given, -@var{buffer_size} is used for its value. - -If @var{flush_interval} is specified for a write test, the request queue is -drained and a flush is issued before new writes are made whenever the numb= er of -remaining requests is a multiple of @var{flush_interval}. If additionally -@code{--no-drain} is specified, a flush is issued without draining the req= uest -queue first. - -If @code{-n} is specified, the native AIO backend is used if possible. On -Linux, this option only works if @code{-t none} or @code{-t directsync} is -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}. - -@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} - -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= }. -The JSON output is an object of QAPI type @code{ImageCheck}. - -If @code{-r} is specified, qemu-img tries to repair any inconsistencies fo= und -during the check. @code{-r leaks} repairs only cluster leaks, whereas -@code{-r all} fixes all kinds of errors, with a higher risk of choosing the -wrong fix or hiding corruption that has already occurred. - -Only the formats @code{qcow2}, @code{qed} and @code{vdi} support -consistency checks. - -In case the image does not have any inconsistencies, check exits with @cod= e{0}. -Other exit codes indicate the kind of inconsistency found or if another er= ror -occurred. The following table summarizes all exit codes of the check subco= mmand: - -@table @option - -@item 0 -Check completed, the image is (now) consistent -@item 1 -Check not completed because of internal errors -@item 2 -Check completed, image is corrupted -@item 3 -Check completed, image has leaked clusters, but is not corrupted -@item 63 -Checks are not supported by the image format - -@end table - -If @code{-r} is specified, exit codes representing the image state refer t= o 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. - -@item commit [--object @var{objectdef}] [--image-opts] [-q] [-f @var{fmt}]= [-t @var{cache}] [-b @var{base}] [-d] [-p] @var{filename} - -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 -resized to be the same size as the snapshot. If the snapshot is smaller t= han -the backing file, the backing file will not be truncated. If you want the -backing file to match the size of the smaller snapshot, you can safely tru= ncate -it yourself once the commit operation successfully completes. - -The image @var{filename} is emptied after the operation has succeeded. If = you do -not need @var{filename} afterwards and intend to drop it, you may skip emp= tying -@var{filename} by specifying the @code{-d} flag. - -If the backing chain of the given image file @var{filename} has more than = one -layer, the backing file into which the changes will be committed may be -specified as @var{base} (which has to be part of @var{filename}'s backing -chain). If @var{base} is not specified, the immediate backing file of the = top -image (which is @var{filename}) will be used. Note that after a commit ope= ration -all images between @var{base} and the top image will be invalid and may re= turn -garbage data when read. For this reason, @code{-b} implies @code{-d} (so t= hat -the top image stays valid). - -@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} - -Check if two images have the same content. You can compare images with -different format or settings. - -The format is probed unless you specify it by @var{-f} (used for -@var{filename1}) and/or @var{-F} (used for @var{filename2}) option. - -By default, images with different size are considered identical if the lar= ger -image contains only unallocated and/or zeroed sectors in the area after th= e end -of the other image. In addition, if any sector is not allocated in one ima= ge -and contains only zero bytes in the second one, it is evaluated as equal. = You -can use Strict mode by specifying the @var{-s} option. When compare runs in -Strict mode, it fails in case image size differs or a sector is allocated = in -one image and is not allocated in the second one. - -By default, compare prints out a result message. This message displays -information that both images are same or the position of the first differe= nt -byte. In addition, result message can report different image size in case -Strict mode is used. - -Compare exits with @code{0} in case the images are equal and with @code{1} -in case the images differ. Other exit codes mean an error occurred during -execution and standard error output should contain an error message. -The following table sumarizes all exit codes of the compare subcommand: - -@table @option - -@item 0 -Images are identical -@item 1 -Images differ -@item 2 -Error on opening an image -@item 3 -Error on checking a sector allocation -@item 4 -Error on reading data - -@end table - -@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] @var{filename} [@var{filename2} [...]] @var{output_filename} - -Convert the disk image @var{filename} or a snapshot @var{snapshot_param} -to disk image @var{output_filename} using format @var{output_fmt}. It can = be optionally compressed (@code{-c} -option) or use any format specific options like encryption (@code{-o} opti= on). - -Only the formats @code{qcow} and @code{qcow2} support compression. The -compression is read-only. It means that if a compressed sector is -rewritten, then it is rewritten as uncompressed data. - -Image conversion is also useful to get smaller image when using a -growable format such as @code{qcow}: the empty sectors are detected and -suppressed from the destination image. - -@var{sparse_size} indicates the consecutive number of bytes (defaults to 4= k) -that must contain only zeros for qemu-img to create a sparse image during -conversion. If @var{sparse_size} is 0, the source will not be scanned for -unallocated or zero sectors, and the destination image will always be -fully allocated. - -You can use the @var{backing_file} option to force the output image to be -created as a copy on write image of the specified base image; the -@var{backing_file} should have the same content as the input's base image, -however the path, image format, etc may differ. - -If a relative path name is given, the backing file is looked up relative to -the directory containing @var{output_filename}. - -If the @code{-n} option is specified, the target volume creation will be -skipped. This is useful for formats such as @code{rbd} if the target -volume has already been created with site specific options that cannot -be supplied through qemu-img. - -Out of order writes can be enabled with @code{-W} to improve performance. -This is only recommended for preallocated devices like host devices or oth= er -raw block devices. Out of order write does not work in combination with -creating compressed images. - -@var{num_coroutines} specifies how many coroutines work in parallel during -the convert process (defaults to 8). - -@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}] - -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} -that enable additional features of this format. - -If the option @var{backing_file} is specified, then the image will record -only the differences from @var{backing_file}. No size needs to be specifie= d in -this case. @var{backing_file} will never be modified unless you use the -@code{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 @var{filename}. - -Note that a given backing file will be opened to check that it is valid. U= se -the @code{-u} option to enable unsafe backing file mode, which means that = the -image will be created even if the associated backing file cannot be opened= . A -matching backing file must be created or additional options be used to mak= e the -backing file specification valid when you want to use an image created this -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. - -@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} - -Dd copies from @var{input} file to @var{output} file converting it from -@var{fmt} format to @var{output_fmt} format. - -The data is by default read and written using blocks of 512 bytes but can = be -modified by specifying @var{block_size}. If count=3D@var{blocks} is specif= ied -dd will stop reading input after reading @var{blocks} input blocks. - -The size syntax is similar to dd(1)'s size syntax. - -@item info [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--out= put=3D@var{ofmt}] [--backing-chain] [-U] @var{filename} - -Give information about the disk image @var{filename}. Use it in -particular to know the size reserved on disk which can be different -from the displayed size. If VM snapshots are stored in the disk image, -they are displayed too. - -If a disk image has a backing file chain, information about each disk imag= e in -the chain can be recursively enumerated by using the option @code{--backin= g-chain}. - -For instance, if you have an image chain like: - -@example -base.qcow2 <- snap1.qcow2 <- snap2.qcow2 -@end example - -To enumerate information about each disk image in the above chain, startin= g from top to base, do: - -@example -qemu-img info --backing-chain snap2.qcow2 -@end example - -The command can output in the format @var{ofmt} which is either @code{huma= n} or -@code{json}. The JSON output is an object of QAPI type @code{ImageInfo}; = with -@code{--backing-chain}, it is an array of @code{ImageInfo} objects. - -@code{--output=3Dhuman} reports the following information (for every image= in the -chain): -@table @var -@item image -The image file name - -@item file format -The image format - -@item virtual size -The size of the guest disk - -@item disk size -How much space the image file occupies on the host file system (may be sho= wn as -0 if this information is unavailable, e.g. because there is no file system) - -@item cluster_size -Cluster size of the image format, if applicable - -@item encrypted -Whether the image is encrypted (only present if so) - -@item cleanly shut down -This is shown as @code{no} if the image is dirty and will have to be -auto-repaired the next time it is opened in qemu. - -@item backing file -The backing file name, if present - -@item backing file format -The format of the backing file, if the image enforces it - -@item Snapshot list -A list of all internal snapshots - -@item Format specific information -Further information whose structure depends on the image format. This sec= tion -is a textual representation of the respective @code{ImageInfoSpecific*} QA= PI -object (e.g. @code{ImageInfoSpecificQCow2} for qcow2 images). -@end table - -@item map [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--outp= ut=3D@var{ofmt}] [-U] @var{filename} - -Dump the metadata of image @var{filename} and its backing file chain. -In particular, this commands dumps the allocation state of every sector -of @var{filename}, together with the topmost file that allocates it in -the backing file chain. - -Two option formats are possible. The default format (@code{human}) -only dumps known-nonzero areas of the file. Known-zero parts of the -file are omitted altogether, and likewise for parts that are not allocated -throughout the chain. @command{qemu-img} output will identify a file -from where the data can be read, and the offset in the file. Each line -will include four fields, the first three of which are hexadecimal -numbers. For example the first line of: -@example -Offset Length Mapped to File -0 0x20000 0x50000 /tmp/overlay.qcow2 -0x100000 0x10000 0x95380000 /tmp/backing.qcow2 -@end example -@noindent -means that 0x20000 (131072) bytes starting at offset 0 in the image are -available in /tmp/overlay.qcow2 (opened in @code{raw} format) starting -at offset 0x50000 (327680). Data that is compressed, encrypted, or -otherwise not available in raw format will cause an error if @code{human} -format is in use. Note that file names can include newlines, thus it is -not safe to parse this output format in scripts. - -The alternative format @code{json} will return an array of dictionaries -in JSON format. It will include similar information in -the @code{start}, @code{length}, @code{offset} fields; -it will also include other more specific information: -@itemize @minus -@item -whether the sectors contain actual data or not (boolean field @code{data}; -if false, the sectors are either unallocated or stored as optimized -all-zero clusters); - -@item -whether the data is known to read as zero (boolean field @code{zero}); - -@item -in order to make the output shorter, the target file is expressed as -a @code{depth}; for example, a depth of 2 refers to the backing file -of the backing file of @var{filename}. -@end itemize - -In JSON format, the @code{offset} field is optional; it is absent in -cases where @code{human} format would omit the entry or exit with an error. -If @code{data} is false and the @code{offset} field is present, the -corresponding sectors in the file are not yet in use, but they are -preallocated. - -For more information, consult @file{include/block/block.h} in QEMU's -source code. - -@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}] - -Calculate the file size required for a new image. This information can be= used -to size logical volumes or SAN LUNs appropriately for the image that will = be -placed in them. The values reported are guaranteed to be large enough to = fit -the image. The command can output in the format @var{ofmt} which is either -@code{human} or @code{json}. The JSON output is an object of QAPI type -@code{BlockMeasureInfo}. - -If the size @var{N} is given then act as if creating a new empty image file -using @command{qemu-img create}. If @var{filename} is given then act as if -converting an existing image file using @command{qemu-img convert}. The f= ormat -of the new file is given by @var{output_fmt} while the format of an existi= ng -file is given by @var{fmt}. - -A snapshot in an existing image can be specified using @var{snapshot_param= }. - -The following fields are reported: -@example -required size: 524288 -fully allocated size: 1074069504 -@end example - -The @code{required size} is the file size of the new image. It may be sma= ller -than the virtual disk size if the image format supports compact representa= tion. - -The @code{fully allocated size} is the file size of the new image once dat= a has -been written to all sectors. This is the maximum size that the image file= can -occupy with the exception of internal snapshots, dirty bitmaps, vmstate da= ta, -and other advanced image format features. - -@item snapshot [--object @var{objectdef}] [--image-opts] [-U] [-q] [-l | -= a @var{snapshot} | -c @var{snapshot} | -d @var{snapshot}] @var{filename} - -List, apply, create or delete snapshots in image @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} - -Changes the backing file of an image. Only the formats @code{qcow2} and -@code{qed} support changing the backing file. - -The backing file is changed to @var{backing_file} and (if the image format= of -@var{filename} supports this) the backing file format is changed to -@var{backing_fmt}. If @var{backing_file} is specified as ``'' (the empty -string), then the image is rebased onto no backing file (i.e. it will exist -independently of any backing file). - -If a relative path name is given, the backing file is looked up relative to -the directory containing @var{filename}. - -@var{cache} specifies the cache mode to be used for @var{filename}, whereas -@var{src_cache} specifies the cache mode for reading backing files. - -There are two different modes in which @code{rebase} can operate: -@table @option -@item Safe mode -This is the default mode and performs a real rebase operation. The new bac= king -file may differ from the old one and qemu-img rebase will take care of kee= ping -the guest-visible content of @var{filename} unchanged. - -In order to achieve this, any clusters that differ between @var{backing_fi= le} -and the old backing file of @var{filename} are merged into @var{filename} -before actually changing the backing file. - -Note that the safe mode is an expensive operation, comparable to converting -an image. It only works if the old backing file still exists. - -@item Unsafe mode -qemu-img uses the unsafe mode if @code{-u} is specified. In this mode, onl= y the -backing file name and format of @var{filename} is changed without any chec= ks -on the file contents. The user must take care of specifying the correct new -backing file, or the guest-visible content of the image will be corrupted. - -This mode is useful for renaming or moving the backing file to somewhere e= lse. -It can be used without an accessible old backing file, i.e. you can use it= to -fix an image whose backing file has already been moved/renamed. -@end table - -You can use @code{rebase} to perform a ``diff'' operation on two -disk images. This can be useful when you have copied or cloned -a guest, and you want to get back to a thin image on top of a -template or base image. - -Say that @code{base.img} has been cloned as @code{modified.img} by -copying it, and that the @code{modified.img} guest has run so there -are now some changes compared to @code{base.img}. To construct a thin -image called @code{diff.qcow2} that contains just the differences, do: - -@example -qemu-img create -f qcow2 -b modified.img diff.qcow2 -qemu-img rebase -b base.img diff.qcow2 -@end example - -At this point, @code{modified.img} can be discarded, since -@code{base.img + diff.qcow2} contains the same information. - -@item resize [--object @var{objectdef}] [--image-opts] [-f @var{fmt}] [--p= reallocation=3D@var{prealloc}] [-q] [--shrink] @var{filename} [+ | -]@var{s= ize} - -Change the disk image as if it had been created with @var{size}. - -Before using this command to shrink a disk image, you MUST use file system= and -partitioning tools inside the VM to reduce allocated file systems and part= ition -sizes accordingly. Failure to do so will result in data loss! - -When shrinking images, the @code{--shrink} option must be given. This info= rms -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 -partitioning tools inside the VM to actually begin using the new space on = the -device. - -When growing an image, the @code{--preallocation} option may be used to sp= ecify -how the additional image area should be allocated on the host. See the fo= rmat -description in the @code{NOTES} section which values are allowed. Using t= his -option may result in slightly more data being allocated than necessary. - -@end table -@c man end - -@ignore -@c man begin NOTES -Supported image file formats: - -@table @option -@item raw - -Raw disk image format (default). This format has the advantage of -being simple and easily exportable to all other emulators. If your -file system supports @emph{holes} (for example in ext2 or ext3 on -Linux or NTFS on Windows), then only the written sectors will reserve -space. Use @code{qemu-img info} to know the real size used by the -image or @code{ls -ls} on Unix/Linux. - -Supported options: -@table @code -@item preallocation -Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}= ). -@code{falloc} mode preallocates space for image by calling posix_fallocate= (). -@code{full} mode preallocates space for image by writing data to underlying -storage. This data may or may not be zero, depending on the storage locat= ion. -@end table - -@item qcow2 -QEMU image format, the most versatile format. Use it to have smaller -images (useful if your filesystem does not supports holes, for example -on Windows), optional AES encryption, zlib based compression and -support of multiple VM snapshots. - -Supported options: -@table @code -@item compat -Determines the qcow2 version to use. @code{compat=3D0.10} uses the -traditional image format that can be read by any QEMU since 0.10. -@code{compat=3D1.1} enables image format extensions that only QEMU 1.1 and -newer understand (this is the default). Amongst others, this includes zero -clusters, which allow efficient copy-on-read for sparse images. - -@item backing_file -File name of a base image (see @option{create} subcommand) -@item backing_fmt -Image format of the base image -@item encryption -If this option is set to @code{on}, the image is encrypted with 128-bit AE= S-CBC. - -The use of encryption in qcow and qcow2 images is considered to be flawed = by -modern cryptography standards, suffering from a number of design problems: - -@itemize @minus -@item -The AES-CBC cipher is used with predictable initialization vectors based -on the sector number. This makes it vulnerable to chosen plaintext attacks -which can reveal the existence of encrypted data. -@item -The user passphrase is directly used as the encryption key. A poorly -chosen or short passphrase will compromise the security of the encryption. -@item -In the event of the passphrase being compromised there is no way to -change the passphrase to protect data in any qcow images. The files must -be cloned, using a different encryption passphrase in the new file. The -original file must then be securely erased using a program like shred, -though even this is ineffective with many modern storage technologies. -@item -Initialization vectors used to encrypt sectors are based on the -guest virtual sector number, instead of the host physical sector. When -a disk image has multiple internal snapshots this means that data in -multiple physical sectors is encrypted with the same initialization -vector. With the CBC mode, this opens the possibility of watermarking -attacks if the attack can collect multiple sectors encrypted with the -same IV and some predictable data. Having multiple qcow2 images with -the same passphrase also exposes this weakness since the passphrase -is directly used as the key. -@end itemize - -Use of qcow / qcow2 encryption is thus strongly discouraged. Users are -recommended to use an alternative encryption technology such as the -Linux dm-crypt / LUKS system. - -@item cluster_size -Changes the qcow2 cluster size (must be between 512 and 2M). Smaller clust= er -sizes can improve the image file size whereas larger cluster sizes general= ly -provide better performance. - -@item preallocation -Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{fal= loc}, -@code{full}). An image with preallocated metadata is initially larger but = can -improve performance when the image needs to grow. @code{falloc} and @code{= full} -preallocations are like the same options of @code{raw} format, but sets up -metadata also. - -@item lazy_refcounts -If this option is set to @code{on}, reference count updates are postponed = with -the goal of avoiding metadata I/O and improving performance. This is -particularly interesting with @option{cache=3Dwritethrough} which doesn't = batch -metadata updates. The tradeoff is that after a host crash, the reference c= ount -tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img -check -r all} is required, which may take some time. - -This option can only be enabled if @code{compat=3D1.1} is specified. - -@item nocow -If this option is set to @code{on}, it will turn off COW of the file. It's= only -valid on btrfs, no effect on other file systems. - -Btrfs has low performance when hosting a VM image file, even more when the= guest -on the VM also using btrfs as file system. Turning off COW is a way to mit= igate -this bad performance. Generally there are two ways to turn off COW on btrf= s: -a) Disable it by mounting with nodatacow, then all newly created files wil= l be -NOCOW. b) For an empty file, add the NOCOW file attribute. That's what thi= s option -does. - -Note: this option is only valid to new or empty files. If there is an exis= ting -file which is COW and has data blocks already, it couldn't be changed to N= OCOW -by setting @code{nocow=3Don}. One can issue @code{lsattr filename} to chec= k if -the NOCOW flag is set or not (Capital 'C' is NOCOW flag). - -@end table - -@item Other -QEMU also supports various other image file formats for compatibility with -older QEMU versions or other hypervisors, including VMDK, VDI, VHD (vpc), = VHDX, -qcow1 and QED. For a full list of supported formats see @code{qemu-img --h= elp}. -For a more detailed description of these formats, see the QEMU Emulation U= ser -Documentation. - -The main purpose of the block drivers for these formats is image conversio= n. -For running VMs, it is recommended to convert the disk images to either ra= w or -qcow2 in order to achieve good performance. -@end table - - -@c man end - -@setfilename qemu-img -@settitle QEMU disk image utility - -@c man begin SEEALSO -The HTML documentation of QEMU for more precise information and Linux -user mode emulator invocation. -@c man end - -@c man begin AUTHOR -Fabrice Bellard -@c man end - -@end ignore --=20 2.20.1 From nobody Sun May 19 02:26:43 2024 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=1579634111; cv=none; d=zohomail.com; s=zohoarc; b=RlAqfzcrhux6vMWyQzYxiPaX1J8G7odOQzIX6+aPVkTerP4/JCNArM4twta5gOfTnozTTo+O4XKCsda4hc8VbSbpsReh8ilb0WXWLF4Z1w0hOzPdf60+UslDYKfHjaQgosP2Dad0pBF6hJWmyj6LpLHp3yXOKnzt4gsL24Av6IM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1579634111; 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=uKabW15C4n2jmTQFgY3S92jryc7MUatzd/T/Wg9/UyQ=; b=DaDeG9r5DbgnK+fDakUlHgigdPLdXPUx5Fuc2gQMPCunwANXCc+RthbnSN2RZCXJjK+K2z5STcpODdyp3vLCkk/4/4a1jhcG3tNu1l6sQ1n1JRX6thRoVreyHEm5lVWw+9gcg9lQI9G4H7RLoIq324SP3Du8Mzsew8Tezkz+4BQ= 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 1579634111664719.6987801954551; Tue, 21 Jan 2020 11:15:11 -0800 (PST) Received: from localhost ([::1]:59948 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityzW-0007p8-8j for importer@patchew.org; Tue, 21 Jan 2020 14:15:10 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59321) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ityvH-0002Uc-In for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:49 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ityvF-0004Sm-M4 for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:47 -0500 Received: from mail-wr1-x433.google.com ([2a00:1450:4864:20::433]:34534) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1ityvF-0004SO-G7 for qemu-devel@nongnu.org; Tue, 21 Jan 2020 14:10:45 -0500 Received: by mail-wr1-x433.google.com with SMTP id t2so4597224wrr.1 for ; Tue, 21 Jan 2020 11:10:45 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id l3sm49533271wrt.29.2020.01.21.11.10.43 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 21 Jan 2020 11:10:43 -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=uKabW15C4n2jmTQFgY3S92jryc7MUatzd/T/Wg9/UyQ=; b=MvZ/dVW8wolEjhmjiouLjQjTrcZ3sEC25hTaao7qYEZfwtwjj9PSjWIGD3YFBBEEBW d7GE2o8XNLK8QokqxFOPjLQZqJCH6fQIvbTRcTuSWqQDpSXNpR9q3Q/vCpuy7jU+E2Zm A8djSlFV/xsq0sJCaTRfR7//KVK3Ziohm6Zy8MCRkD8RCe0ZFhyFC6FUyfIisbaPhMLU UWOh3wjmCUtbZtdbvR8/ok88OdMDsiGazUNGa3V8gR3t+7cPWn4an4cKLH3if2dpQrkM Ock+0JmH/tzI0Oq2Vsb8xuxTvNNyLNZZyNkDS0pY3zZnX3eS1S572b6FXKwtzkZFmq/A fg4g== 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=uKabW15C4n2jmTQFgY3S92jryc7MUatzd/T/Wg9/UyQ=; b=JSFK9HwzCwBX0ooFStnmjd/13itflmf4uaGy3889XPf0ZZworIMbutfdwthZ3QtMYB XendD7PDvlootnIIr2brtZVmmRwT8AlGt0HoV3xMM1Xa5yvMOifqNoHbECr+/fxqbhd3 p0mWPQEC0+KJtHU+XXW6I3cdM56ET8N2MW6sd8dpSgaE4KbpSLvZLn9QzownPxcywbKv xRURVHHaUrn4Xd+L6xY7D5rpmThMFGoTNfh41zatFma/kXET6MSlvMgQ+1ykC6UytvRy +NYcgMr3fyTmcF8Szs7K7HcfXu2gsJiVNwDBsgUoTgCPm+s8QVkF+xq75IDrJ99XiSif VEOg== X-Gm-Message-State: APjAAAUlVPvKIFudCAJV5GLayQK3BXz8mdOX4ld0jUFcxXibWFf6Z411 ySLXik2CrD12Z/DFTjQyl6wNgzzxbkP5FQ== X-Google-Smtp-Source: APXvYqxa+iJsilZPTd/ASZguUasNLd2FKdDxxuqG8+qI8HHk22yFpPIcT0WC04BWTDQ7WFVbYWZHZw== X-Received: by 2002:adf:e40f:: with SMTP id g15mr6607988wrm.223.1579633844192; Tue, 21 Jan 2020 11:10:44 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PATCH 5/5] qemu-img-cmds.hx: Remove texinfo document fragments Date: Tue, 21 Jan 2020 19:10:33 +0000 Message-Id: <20200121191033.28195-6-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200121191033.28195-1-peter.maydell@linaro.org> References: <20200121191033.28195-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::433 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 , 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" Now the qemu-img documentation has been converted to rST, we can remove the texinfo document fragments from qemu-img-cmds.hx, as they are no longer used. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson --- qemu-img-cmds.hx | 56 +++--------------------------------------------- 1 file changed, 3 insertions(+), 53 deletions(-) diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx index 0c8b210b3c3..32e999d0965 100644 --- a/qemu-img-cmds.hx +++ b/qemu-img-cmds.hx @@ -1,143 +1,93 @@ HXCOMM Keep the list of subcommands sorted by name. HXCOMM Use DEFHEADING() to define headings in both help text and texi -HXCOMM Text between STEXI and ETEXI are copied to texi version and +HXCOMM Text between SRST and ERST are copied to rST version and HXCOMM discarded from C version HXCOMM DEF(command, callback, arg_string) is used to construct HXCOMM command structures and help message. -HXCOMM HXCOMM can be used for comments, discarded from both texi and C +HXCOMM HXCOMM can be used for comments, discarded from both rST and C =20 -HXCOMM When amending the TEXI sections, please remember to copy the usage +HXCOMM When amending the rST sections, please remember to copy the usage HXCOMM over to the per-command sections in qemu-img.texi. =20 -STEXI -@table @option -ETEXI - DEF("amend", img_amend, "amend [--object objectdef] [--image-opts] [-p] [-q] [-f fmt] [-t cach= e] -o options filename") -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 - -STEXI -@end table -ETEXI --=20 2.20.1