From patchwork Sun May 8 03:16:40 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Eric Blake X-Patchwork-Id: 9038631 Return-Path: X-Original-To: patchwork-qemu-devel@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 1F4AABF29F for ; Sun, 8 May 2016 03:53:16 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 51D3F20125 for ; Sun, 8 May 2016 03:53:15 +0000 (UTC) Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 5646E20122 for ; Sun, 8 May 2016 03:53:14 +0000 (UTC) Received: from localhost ([::1]:35826 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1azFmK-0005tp-6Q for patchwork-qemu-devel@patchwork.kernel.org; Sat, 07 May 2016 23:53:12 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:49551) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1azFm2-0005cg-Mp for qemu-devel@nongnu.org; Sat, 07 May 2016 23:53:06 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1azFlu-0004DM-IJ for qemu-devel@nongnu.org; Sat, 07 May 2016 23:52:53 -0400 Received: from resqmta-po-04v.sys.comcast.net ([2001:558:fe16:19:96:114:154:163]:53760) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1azFlu-0004DF-Dt for qemu-devel@nongnu.org; Sat, 07 May 2016 23:52:46 -0400 Received: from resomta-po-19v.sys.comcast.net ([96.114.154.243]) by comcast with SMTP id zFCuaON1qIY3MzFDCahQKj; Sun, 08 May 2016 03:16:54 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=comcast.net; s=q20140121; t=1462677414; bh=9Dk5QK9J4gBtocn8TMAoJKD5cueZcfs20XyGOSabIPI=; h=Received:Received:From:To:Subject:Date:Message-Id; b=UmJZkoSeP+1oyvlcNmghnl2FfQ+gatrC9WQks/IfLTTTzOaPoDirt3DRszJESQcti knSKBcehR58E93ioo1BBwqyZtS0ly5AiF2AG/VnFuMRunE8UEz2QEAdDPwkmBgVQUC eq3BSPejxPf7yrGAU76NtrhH4q2QGL4H0csXVSX62ny0ld6FnaRYLWYDPWRhqeCout Ka5Aaiozj50sYuZwF7ZXUwLnNYGjOtfPlyMWx6QMeaFy8KSINu5FtaOXz6sN28OkmB x3omTVXXOg4uIBKGy2xCmlyaA8dsr3LHekF3xAFd5HuBudiQLWydzSffsuCWmyXwgL 6IqAuruXh5Ngw== Received: from red.redhat.com ([24.10.254.122]) by resomta-po-19v.sys.comcast.net with comcast id rfGl1s0092fD5rL01fGttw; Sun, 08 May 2016 03:16:53 +0000 From: Eric Blake To: qemu-devel@nongnu.org Date: Sat, 7 May 2016 21:16:40 -0600 Message-Id: <1462677405-4752-2-git-send-email-eblake@redhat.com> X-Mailer: git-send-email 2.5.5 In-Reply-To: <1462677405-4752-1-git-send-email-eblake@redhat.com> References: <1462677405-4752-1-git-send-email-eblake@redhat.com> X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2001:558:fe16:19:96:114:154:163 Subject: [Qemu-devel] [PATCH v5 1/6] qemu-io: Add missing option documentation X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Kevin Wolf , kwolf@nongnu.org, qemu-block@nongnu.org, mreitz@redhat.com Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Spam-Status: No, score=-6.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_HI, T_DKIM_INVALID, UNPARSEABLE_RELAY autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The Usage: summary is missing several options, but rather than having to maintain it, it's simpler to just state [OPTIONS], since the options are spelled out below. Commit 499afa2 added --image-opts, but forgot to document it in --help. Likewise for commit 9e8f183 and -d/--discard. Commit e3aff4f6 put "-o/--offset" in the long opts, but it has never been honored. Add a note that '-n' is short for '-t none'. Commit 9a2d77ad killed the -C option, but forgot to undocument it for the 'open' subcommand. Finally, commit 10d9d75 removed -g/--growable, but forgot to cull it from the valid short options. Signed-off-by: Eric Blake Reviewed-by: Max Reitz --- v5: more improvements --- qemu-io.c | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/qemu-io.c b/qemu-io.c index 0598251..0a1a3df 100644 --- a/qemu-io.c +++ b/qemu-io.c @@ -101,7 +101,7 @@ static void open_help(void) " opens a new file in the requested mode\n" "\n" " Example:\n" -" 'open -Cn /tmp/data' - creates/opens data file read-write and uncached\n" +" 'open -n -o driver=raw /tmp/data' - opens raw data file read-write, uncached\n" "\n" " Opens a file for subsequent use by all of the other qemu-io commands.\n" " -r, -- open file read-only\n" @@ -120,7 +120,7 @@ static const cmdinfo_t open_cmd = { .argmin = 1, .argmax = -1, .flags = CMD_NOFILE_OK, - .args = "[-Crsn] [-o options] [path]", + .args = "[-rsn] [-o options] [path]", .oneline = "open the file specified by path", .help = open_help, }; @@ -144,7 +144,7 @@ static int open_f(BlockBackend *blk, int argc, char **argv) QemuOpts *qopts; QDict *opts; - while ((c = getopt(argc, argv, "snrgo:")) != -1) { + while ((c = getopt(argc, argv, "snro:")) != -1) { switch (c) { case 's': flags |= BDRV_O_SNAPSHOT; @@ -216,20 +216,22 @@ static const cmdinfo_t quit_cmd = { static void usage(const char *name) { printf( -"Usage: %s [-h] [-V] [-rsnm] [-f FMT] [-c STRING] ... [file]\n" +"Usage: %s [OPTIONS]... [-c STRING]... [file]\n" "QEMU Disk exerciser\n" "\n" " --object OBJECTDEF define an object such as 'secret' for\n" " passwords and/or encryption keys\n" +" --image-opts treat file as option string\n" " -c, --cmd STRING execute command with its arguments\n" " from the given string\n" " -f, --format FMT specifies the block driver to use\n" " -r, --read-only export read-only\n" " -s, --snapshot use snapshot file\n" -" -n, --nocache disable host cache\n" +" -n, --nocache disable host cache, short for -t none\n" " -m, --misalign misalign allocations for O_DIRECT\n" " -k, --native-aio use kernel AIO implementation (on Linux only)\n" " -t, --cache=MODE use the given cache mode for the image\n" +" -d, --discard=MODE use the given discard mode for the image\n" " -T, --trace FILE enable trace events listed in the given file\n" " -h, --help display this help and exit\n" " -V, --version output version information and exit\n" @@ -410,11 +412,10 @@ static QemuOptsList file_opts = { int main(int argc, char **argv) { int readonly = 0; - const char *sopt = "hVc:d:f:rsnmgkt:T:"; + const char *sopt = "hVc:d:f:rsnmkt:T:"; const struct option lopt[] = { { "help", no_argument, NULL, 'h' }, { "version", no_argument, NULL, 'V' }, - { "offset", required_argument, NULL, 'o' }, { "cmd", required_argument, NULL, 'c' }, { "format", required_argument, NULL, 'f' }, { "read-only", no_argument, NULL, 'r' },