From patchwork Fri Aug 26 09:16:42 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Reda Sallahi X-Patchwork-Id: 9301021 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 428C1607F0 for ; Fri, 26 Aug 2016 09:27:11 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 3234D295F1 for ; Fri, 26 Aug 2016 09:27:11 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 27047295F5; Fri, 26 Aug 2016 09:27:11 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.8 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_HI, T_DKIM_INVALID autolearn=ham version=3.3.1 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.wl.linuxfoundation.org (Postfix) with ESMTPS id 6FB2F295F1 for ; Fri, 26 Aug 2016 09:27:10 +0000 (UTC) Received: from localhost ([::1]:59687 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bdDPp-00005k-9Q for patchwork-qemu-devel@patchwork.kernel.org; Fri, 26 Aug 2016 05:27:09 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:53767) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bdDGE-0000EC-Bf for qemu-devel@nongnu.org; Fri, 26 Aug 2016 05:17:15 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bdDG4-0003ut-8a for qemu-devel@nongnu.org; Fri, 26 Aug 2016 05:17:13 -0400 Received: from mail-wm0-x243.google.com ([2a00:1450:400c:c09::243]:36726) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bdDG3-0003ui-U9; Fri, 26 Aug 2016 05:17:04 -0400 Received: by mail-wm0-x243.google.com with SMTP id i138so10524071wmf.3; Fri, 26 Aug 2016 02:17:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=/R3B9BLDwm/de8ISYVwtVNlxuVNDEd5z0sTEqbmF6f4=; b=RhwSDZdMYmwtYzzobpAxx3egmMGyYQX8N1XrFhyZmzZn0W8+33OzsdSSEVTw1NP30d 1lMCU6TsGcPaPIbA79U3YOmyECAbV2obR5XqE2m4urgcJNqSQlKF0vHLRwC4kzEJkjSc OqoSeE3AleBIhuUtbdjzU2Vq2Nhe6TsK07Kx3qHqMIGgQPcMsSHKR7Vz4ihuem0mYaOF 8fx4c/iCVv6i9h9jKwcgnUa/3lYkRnN8tTwgsfVK8ZuZq4G58cioou7c/koU/j3unTpw 0oyXy5I/Zjz9uP4tn6cqG5MdRMOHcQtIw68PCyuYC4XaaxxoStFe8kOVqEKaNYD9LL91 Ny8g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=/R3B9BLDwm/de8ISYVwtVNlxuVNDEd5z0sTEqbmF6f4=; b=PuanEEz+jxttSLWSnSXNFmNNQCmyrtkqLTxYDpPDrdabsRtgD5nEzfXodu6dSXYrv+ PzKXaupIf+tMMhhNISOOvyInJNrJ+G9BYNL4LxGDOsJEGmtbVlBsE4Hh1ves8BbGDrdM nnp4yI8Rv3MQPA0/F7osLgJG/ezzAysC3hlrWKelMaokJhYE36l1p/akn83xeqdOUHzB iIyRgsaNPQP0uSbX1+FSmogCPYJDjiTQ9vmxxw4KtXorlTLfCTLMzVIX4ZGX9cM98ydn ysdRDAl8dYkOfPoikaW+nuAjrOI88e3TKkcDgVOgD7xjv65di56tTn09dLQdHGIMw3WA SlcA== X-Gm-Message-State: AE9vXwMz/F51g+vCZFaA1ltletNppAeEeFe73YbP86OT6ewgZ6ydTeivOqJ1zBCt/ZYRsw== X-Received: by 10.194.135.147 with SMTP id ps19mr2612590wjb.6.1472203023132; Fri, 26 Aug 2016 02:17:03 -0700 (PDT) Received: from cinque_stelle.sm14.sm.cri.epita.net ([163.5.208.144]) by smtp.gmail.com with ESMTPSA id f4sm42716517wmf.8.2016.08.26.02.17.02 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 26 Aug 2016 02:17:02 -0700 (PDT) From: Reda Sallahi To: qemu-devel@nongnu.org Date: Fri, 26 Aug 2016 11:16:42 +0200 Message-Id: <20160826091643.15841-7-fullmanet@gmail.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20160826091643.15841-1-fullmanet@gmail.com> References: <20160826091643.15841-1-fullmanet@gmail.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2a00:1450:400c:c09::243 Subject: [Qemu-devel] [PATCH v2 6/7] qemu-img: clean up dd 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 , Fam Zheng , qemu-block@nongnu.org, Max Reitz , Reda Sallahi , Stefan Hajnoczi Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP The dd section on qemu-img --help was a bit hard to read since it was not well aligned. This patch fixes the display problem and also makes the sentences on the .texi file more consistent with one another (uppercase and conjugasion). Signed-off-by: Reda Sallahi Reviewed-by: Stefan Hajnoczi --- qemu-img.c | 48 +++++++++++++++++++++++++----------------------- qemu-img.texi | 48 ++++++++++++++++++++++++------------------------ 2 files changed, 49 insertions(+), 47 deletions(-) diff --git a/qemu-img.c b/qemu-img.c index 55977ff..207e16c 100644 --- a/qemu-img.c +++ b/qemu-img.c @@ -169,37 +169,39 @@ static void QEMU_NORETURN help(void) " '-s' run in Strict mode - fail on different image size or sector allocation\n" "\n" "Parameters to dd subcommand:\n" - " 'bs=BYTES' read and write up to BYTES bytes at a time " + " 'bs=BYTES' read and write up to BYTES bytes at a time " "(default: 512)\n" - " 'count=N' copy only N input blocks\n" - " 'if=FILE' read from FILE\n" - " 'of=FILE' write to FILE\n" - " 'skip=N' skip N bs-sized blocks at the start of input\n" - " 'seek=N' seek N bs-sized blocks at the start of output\n" - " 'conv=CONVS' do not truncate the output file\n" + " 'count=N' copy only N input blocks\n" + " 'if=FILE' read from FILE\n" + " 'of=FILE' write to FILE\n" + " 'skip=N' skip N bs-sized blocks at the start of input\n" + " 'seek=N' seek N bs-sized blocks at the start of output\n" + " 'conv=CONVS' do not truncate the output file\n" " 'iflags=FLAGS' read using the comma-separated flags list\n" " 'oflags=FLAGS' read using the comma-separated flags list\n" " 'status=LEVEL' the LEVEL of information to print to stderr\n\n" "List of LEVELS for dd:\n" - " 'none' surpresses everything but error messages\n" - " 'noxfer' surpresses the final transfer statistics\n\n" + " 'none' surpress everything but error messages\n" + " 'noxfer' surpress the final transfer statistics\n\n" "List of CONVS for dd:\n" - " 'notrunc' do not truncate the output file\n" - " 'noerror' continue in the event of read errors\n" - " 'excl' fail if output already exists\n" - " 'nocreat' do not create the output file\n" - " 'fsync' physically write output file data before finishing\n" - " 'fdatasync' physically write output file data before finishing\n" - " 'sync' pad every input block with NULs\n" - " 'sparse' seek rather than write the output for NUL input" + " 'notrunc' do not truncate the output file\n" + " 'noerror' continue in the event of read errors\n" + " 'excl' fail if output already exists\n" + " 'nocreat' do not create the output file\n" + " 'fsync' physically write output file data before" + " finishing\n" + " 'fdatasync' physically write output file data before" + " finishing\n" + " 'sync' pad every input block with NULs\n" + " 'sparse' seek rather than write the output for NUL input" " blocks\n\n" "List of FLAGS for dd:\n" - " 'direct' use direct I/O for data\n" - " 'dsync' use synchronized I/O for data\n" - " 'sync' use synchronized I/O for data\n" - " 'count_bytes' use 'count=N' as a byte count (iflag only)\n" - " 'skip_bytes' use 'skip=N' as a byte count (iflag only)\n" - " 'seek_bytes' use 'seek=N' as a byte count (oflag only)\n"; + " 'direct' use direct I/O for data\n" + " 'dsync' use synchronized I/O for data\n" + " 'sync' use synchronized I/O for data\n" + " 'count_bytes' use 'count=N' as a byte count (iflag only)\n" + " 'skip_bytes' use 'skip=N' as a byte count (iflag only)\n" + " 'seek_bytes' use 'seek=N' as a byte count (oflag only)\n"; printf("%s\nSupported formats:", help_msg); bdrv_iterate_format(format_print, NULL); diff --git a/qemu-img.texi b/qemu-img.texi index c8905c6..a1a17f3 100644 --- a/qemu-img.texi +++ b/qemu-img.texi @@ -144,20 +144,20 @@ Parameters to dd subcommand: @table @option @item bs=@var{block_size} -defines the block size +Defines the block size @item count=@var{blocks} -sets the number of input blocks to copy. In case 'iflags=count_bytes' is +Sets the number of input blocks to copy. In case 'iflags=count_bytes' is specified, 'blocks' is interpreted as a byte count instead of a block count. @item if=@var{input} -sets the input file +Sets the input file @item of=@var{output} -sets the output file. dd truncates the output file to zero if 'conv=notrunc' +Sets the output file. dd truncates the output file to zero if 'conv=notrunc' is not specified. @item skip=@var{blocks} -sets the number of input blocks to skip. In case 'iflags=skip_bytes' is +Sets the number of input blocks to skip. In case 'iflags=skip_bytes' is specified, 'blocks' is interpreted as a byte count instead of a block count. @item seek=@var{blocks} -sets the number of output blocks to skip. In case 'oflags=seek_bytes' is +Sets the number of output blocks to skip. In case 'oflags=seek_bytes' is specified, 'blocks' is interpreted as a byte count instead of a block count. @item conv=@var{convs} Converts the input according to the conversions specified. The conversion list @@ -165,49 +165,49 @@ is separated using commas. The conversion list: @item notrunc -Make dd not truncate output file to zero. +Makes dd not truncate output file to zero. @item sync -Fill every input block size with trailing zero bytes. +Fills every input block size with trailing zero bytes. @item noerror -Continue after read failures. +Continues after read failures. @item fdatasync -Synchronize output data just before finishing. This forces a physical write of output data. +Synchronizes output data just before finishing. This forces a physical write of output data. @item fsync -Synchronize output data just before finishing. This forces a physical write of output data. +Synchronizes output data just before finishing. This forces a physical write of output data. @item excl -Err if the output file already exists. +Errs if the output file already exists. @item nocreat -Do not create the output file; the output file must already exist. +Does not create the output file; the output file must already exist. @item sparse -Seek rather than write NUL output blocks. +Seeks rather than write NUL output blocks. @item iflag=@var{flags} -defines the flags used to read the input file. The flag list is seprated using +Defines the flags used to read the input file. The flag list is seprated using commas. @item oflag=@var{flags} -defines the flags used to write the output file. The flag list is seprated +Defines the flags used to write the output file. The flag list is seprated using commas. The flag list: @item direct -direct I/O for data. +Direct I/O for data. @item dsync -synchronised I/O for data. +Synchronised I/O for data. @item sync -synchronised I/O for data. +Synchronised I/O for data. @item count_bytes -interpret 'count=blocks' as a byte count. Only iflag. +Interprets 'count=blocks' as a byte count. Only iflag. @item skip_bytes -interpret 'skip=blocks' as a byte count. Only iflag. +Interprets 'skip=blocks' as a byte count. Only iflag. @item seek_bytes -interpret 'seek=blocks' as a byte count. Only oflag. +Interprets 'seek=blocks' as a byte count. Only oflag. @item status=@var{level} -Define the level of information to print to stderr. +Defines the level of information to print to stderr. @item none Only error messages are printed. @item noxfer -Do not print the final transfer rate. +Does not print the final transfer rate. @end table