From nobody Thu Nov 13 12:02:46 2025 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=oracle.com ARC-Seal: i=1; a=rsa-sha256; t=1579862358; cv=none; d=zohomail.com; s=zohoarc; b=fpZhzf0vzThNkfhBUK9j/LDy3xGegrw25p6aB40qaP013jXG6xsAgHCv2fNKefs/LW8Gy1BFbPIFZ18AzaOfRDrAr91LftZ1PHE46UXitHCtLvrNh1fbtMDgzvcCzMB8M+Hhrv+7qOVu30cr0di0Pzmsjncu/gzKREzbN8n/8F8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1579862358; 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=kJYuGOHxAJSijG0ahMlaMAPg8iWcWaOUuXKZkKmTajM=; b=n01ihAodOZ6vgvSwlxja25WVIraOIRmpqu+W5siQVgn8ay2uF4iXh5sjyd/kiT0TckKgs+Uv9HJwrR2a30be+9WOWOiNiwMIo2KMMMq5ZTOX64Ypj/JP+a/kn3GMP4VGWrp3tnCklQvppJ5qU51Ne0NeV48/NpRpwf9EZ3RZf+o= 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 157986235835161.98490896520548; Fri, 24 Jan 2020 02:39:18 -0800 (PST) Received: from localhost ([::1]:40292 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iuwMv-0006RM-9i for importer@patchew.org; Fri, 24 Jan 2020 05:39:17 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:47668) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iuwLp-0005Wo-Le for qemu-devel@nongnu.org; Fri, 24 Jan 2020 05:38:10 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iuwLo-0002Ty-Cz for qemu-devel@nongnu.org; Fri, 24 Jan 2020 05:38:09 -0500 Received: from aserp2120.oracle.com ([141.146.126.78]:50238) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1iuwLl-0002MS-Lw; Fri, 24 Jan 2020 05:38:05 -0500 Received: from pps.filterd (aserp2120.oracle.com [127.0.0.1]) by aserp2120.oracle.com (8.16.0.27/8.16.0.27) with SMTP id 00OANHpE051393; Fri, 24 Jan 2020 10:38:05 GMT Received: from aserp3030.oracle.com (aserp3030.oracle.com [141.146.126.71]) by aserp2120.oracle.com with ESMTP id 2xksyqr853-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 24 Jan 2020 10:38:04 +0000 Received: from pps.filterd (aserp3030.oracle.com [127.0.0.1]) by aserp3030.oracle.com (8.16.0.27/8.16.0.27) with SMTP id 00OAVJGR112268; Fri, 24 Jan 2020 10:36:04 GMT Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by aserp3030.oracle.com with ESMTP id 2xqmuepue4-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Fri, 24 Jan 2020 10:36:04 +0000 Received: from abhmp0003.oracle.com (abhmp0003.oracle.com [141.146.116.9]) by aserv0121.oracle.com (8.14.4/8.13.8) with ESMTP id 00OAa4pa007328; Fri, 24 Jan 2020 10:36:04 GMT Received: from disaster-area.hh.sledj.net (/81.149.164.25) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 24 Jan 2020 02:36:03 -0800 Received: from localhost (disaster-area.hh.sledj.net [local]) by disaster-area.hh.sledj.net (OpenSMTPD) with ESMTPA id 4f429e87; Fri, 24 Jan 2020 10:36:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding; s=corp-2019-08-05; bh=kJYuGOHxAJSijG0ahMlaMAPg8iWcWaOUuXKZkKmTajM=; b=nwIL5M96u+fRUucd+2W4y5k2wj7QcyeRG4jse2aOnCimgRkuRORkEFX7YJON6ePCeN8M fEAw7knrbEfnBPaTtUw0P2vvPjlG2ASNmmOWeL6Qjb/ksJlrd9DrrZcNLk72d7ttMmiI M2co+IZqEQCs0V8RCP1HztsXK4viXk4SDdEk/O41qN0cX1tW2MBcZFw0KNNjEaSqdAu5 ukWVY6jtNcymDZxn+33lmR9VSUP65E7947qKq8KaAyXCSQ3n+JC9d79PlZrrbMCKcw+d QVii+Mk3GYdAW75q1vIjAYl8q2DVz4tJ7OmH2dsMaQ4u+qz8dpYgkh7+sMbJyp3rPpTm Lg== From: David Edmondson To: qemu-devel@nongnu.org, qemu-block@nongnu.org Subject: [PATCH v2 2/2] doc: Use @code rather than @var for options Date: Fri, 24 Jan 2020 10:34:58 +0000 Message-Id: <20200124103458.1525982-3-david.edmondson@oracle.com> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20200124103458.1525982-1-david.edmondson@oracle.com> References: <20200124103458.1525982-1-david.edmondson@oracle.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9509 signatures=668685 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1911140001 definitions=main-2001240086 X-Proofpoint-Virus-Version: vendor=nai engine=6000 definitions=9509 signatures=668685 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1911140001 definitions=main-2001240086 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] X-Received-From: 141.146.126.78 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: David Edmondson 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" Texinfo defines @var for metasyntactic variables and such terms are shown in upper-case or italics in the output of makeinfo. When considering an option to a command, such as "-n", upper-casing is undesirable as it may confuse the reader or be in conflict with the equivalent upper-case option. Replace the use of @var for options with @code to avoid this. Signed-off-by: David Edmondson --- qemu-img.texi | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/qemu-img.texi b/qemu-img.texi index 3b6dfd8682..6b4a1ac961 100644 --- a/qemu-img.texi +++ b/qemu-img.texi @@ -74,13 +74,13 @@ 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. +exclusive with the @code{-f} parameter. =20 @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 +exclusive with the @code{-O} parameters. It is currently required to also = use +the @code{-n} parameter to skip image creation. This restriction may be re= laxed in a future release. =20 @item --force-share (-U) @@ -103,13 +103,13 @@ with or without a command shows help and lists the su= pported formats =20 @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 +If the @code{-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. =20 @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. +in case both @code{-q} and @code{-p} options are used. =20 @item -S @var{size} indicates the consecutive number of bytes that must contain only zeros @@ -298,14 +298,14 @@ the top image stays valid). Check if two images have the same content. You can compare images with different format or settings. =20 -The format is probed unless you specify it by @var{-f} (used for -@var{filename1}) and/or @var{-F} (used for @var{filename2}) option. +The format is probed unless you specify it by @code{-f} (used for +@var{filename1}) and/or @code{-F} (used for @var{filename2}) option. =20 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 +can use Strict mode by specifying the @code{-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. =20 --=20 2.24.1