From patchwork Mon May 19 16:20:21 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Sterba X-Patchwork-Id: 4203061 X-Patchwork-Delegate: dave@jikos.cz Return-Path: X-Original-To: patchwork-linux-btrfs@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 709C7BEEAB for ; Mon, 19 May 2014 16:20:48 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id B5B5B20256 for ; Mon, 19 May 2014 16:20:44 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id A036D202AE for ; Mon, 19 May 2014 16:20:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932454AbaESQU1 (ORCPT ); Mon, 19 May 2014 12:20:27 -0400 Received: from cantor2.suse.de ([195.135.220.15]:35104 "EHLO mx2.suse.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932420AbaESQUX (ORCPT ); Mon, 19 May 2014 12:20:23 -0400 Received: from relay1.suse.de (charybdis-ext.suse.de [195.135.220.254]) by mx2.suse.de (Postfix) with ESMTP id 0D3FBAC77 for ; Mon, 19 May 2014 16:20:22 +0000 (UTC) Received: by ds.suse.cz (Postfix, from userid 10065) id 8E7ADDA8EB; Mon, 19 May 2014 18:20:21 +0200 (CEST) From: David Sterba To: linux-btrfs@vger.kernel.org Cc: David Sterba Subject: [PATCH 4/5] btrfs-progs: doc: make all commands and subcommands bold Date: Mon, 19 May 2014 18:20:21 +0200 Message-Id: X-Mailer: git-send-email 1.9.0 In-Reply-To: References: Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Spam-Status: No, score=-7.5 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable 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 Italic format is used for parameters and values, bold makes the text visually separated. Signed-off-by: David Sterba --- Documentation/btrfs-balance.txt | 22 +++++++-------- Documentation/btrfs-check.txt | 14 +++++----- Documentation/btrfs-convert.txt | 6 ++--- Documentation/btrfs-debug-tree.txt | 6 ++--- Documentation/btrfs-device.txt | 20 +++++++------- Documentation/btrfs-filesystem.txt | 22 +++++++-------- Documentation/btrfs-find-root.txt | 6 ++--- Documentation/btrfs-image.txt | 6 ++--- Documentation/btrfs-inspect-internal.txt | 16 +++++------ Documentation/btrfs-map-logical.txt | 6 ++--- Documentation/btrfs-property.txt | 20 +++++++------- Documentation/btrfs-qgroup.txt | 24 ++++++++--------- Documentation/btrfs-quota.txt | 14 +++++----- Documentation/btrfs-receive.txt | 10 +++---- Documentation/btrfs-replace.txt | 14 +++++----- Documentation/btrfs-rescue.txt | 14 +++++----- Documentation/btrfs-restore.txt | 10 +++---- Documentation/btrfs-scrub.txt | 20 +++++++------- Documentation/btrfs-send.txt | 8 +++--- Documentation/btrfs-show-super.txt | 6 ++--- Documentation/btrfs-subvolume.txt | 28 +++++++++---------- Documentation/btrfs-zero-log.txt | 12 ++++----- Documentation/btrfs.txt | 46 ++++++++++++++++---------------- Documentation/btrfstune.txt | 6 ++--- Documentation/fsck.btrfs.txt | 6 ++--- Documentation/mkfs.btrfs.txt | 8 +++--- 26 files changed, 185 insertions(+), 185 deletions(-) diff --git a/Documentation/btrfs-balance.txt b/Documentation/btrfs-balance.txt index 7edc44b150dd..d34833d6f380 100644 --- a/Documentation/btrfs-balance.txt +++ b/Documentation/btrfs-balance.txt @@ -7,11 +7,11 @@ btrfs-balance - balance btrfs filesystem SYNOPSIS -------- -'btrfs [filesystem] balance' | +*btrfs [filesystem] balance* | DESCRIPTION ----------- -'btrfs balance' is used to balance chunks in a btrfs filesystem across +*btrfs balance* is used to balance chunks in a btrfs filesystem across multiple or even single device. See `btrfs-device`(8) for more details about the effect on device management. @@ -21,10 +21,10 @@ SUBCOMMAND :: Balance chunks across the devices *online*. + -'btrfs balance ' is deprecated, -please use 'btrfs balance start' command instead. +*btrfs balance * is deprecated, +please use *btrfs balance start* command instead. -'start' [options] :: +*start* [options] :: Balance chunks across the devices *online*. + Balance and/or convert (change allocation profile of) chunks that @@ -47,28 +47,28 @@ be verbose -f:::: force reducing of metadata integrity -'pause' :: +*pause* :: Pause running balance. -'cancel' :: +*cancel* :: Cancel running or paused balance. -'resume' :: +*resume* :: Resume interrupted balance. -'status' [-v] :: +*status* [-v] :: Show status of running or paused balance. + If '-v' option is given, output will be verbose. EXIT STATUS ----------- -'btrfs balance' returns a zero exist status if it succeeds. Non zero is +*btrfs balance* returns a zero exist status if it succeeds. Non zero is returned in case of failure. AVAILABILITY ------------ -'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +*btrfs* is part of btrfs-progs. Btrfs filesystem is currently under heavy development, and not suitable for any uses other than benchmarking and review. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for diff --git a/Documentation/btrfs-check.txt b/Documentation/btrfs-check.txt index ce491734a981..073667265c13 100644 --- a/Documentation/btrfs-check.txt +++ b/Documentation/btrfs-check.txt @@ -7,18 +7,18 @@ btrfs-check - check or repair a btrfs filesystem offline SYNOPSIS -------- -'btrfs check' [options] +*btrfs check* [options] DESCRIPTION ----------- -'btrfs check' is used to check or repair a btrfs filesystem offline. +*btrfs check* is used to check or repair a btrfs filesystem offline. -NOTE: Since btrfs is under heavy development especially the 'btrfs check' +NOTE: Since btrfs is under heavy development especially the *btrfs check* command, it is *highly* recommended to read the following btrfs wiki before -executing 'btrfs check' with '--repair' option: + +executing *btrfs check* with '--repair' option: + https://btrfs.wiki.kernel.org/index.php/Btrfsck -'btrfsck' is an alias of 'btrfs check' command and is now deprecated. +*btrfsck* is an alias of *btrfs check* command and is now deprecated. OPTIONS ------- @@ -33,12 +33,12 @@ create a new extent tree. EXIT STATUS ----------- -'btrfs check' returns a zero exist status if it succeeds. Non zero is +*btrfs check* returns a zero exist status if it succeeds. Non zero is returned in case of failure. AVAILABILITY ------------ -'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +*btrfs* is part of btrfs-progs. Btrfs filesystem is currently under heavy development, and not suitable for any uses other than benchmarking and review. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for diff --git a/Documentation/btrfs-convert.txt b/Documentation/btrfs-convert.txt index 780ca9ef052a..ed61d143d59f 100644 --- a/Documentation/btrfs-convert.txt +++ b/Documentation/btrfs-convert.txt @@ -7,11 +7,11 @@ btrfs-convert - convert from ext2/3/4 filesystem to btrfs or rollback SYNOPSIS -------- -'btrfs-convert' [options] +*btrfs-convert* [options] DESCRIPTION ----------- -'btrfs-convert' is used to convert existed ext2/3/4 to btrfs filesystem, +*btrfs-convert* is used to convert existed ext2/3/4 to btrfs filesystem, and the original filesystem image is accessible as from separate subvolume named 'ext2_subvol' as file image. @@ -28,7 +28,7 @@ Roll back to ext2fs. EXIT STATUS ----------- -'btrfs-convert' will return 0 if no error happened. +*btrfs-convert* will return 0 if no error happened. If any problems happened, 1 will be returned. AUTHOR diff --git a/Documentation/btrfs-debug-tree.txt b/Documentation/btrfs-debug-tree.txt index 80a85d44cdbb..bfc8aa401abb 100644 --- a/Documentation/btrfs-debug-tree.txt +++ b/Documentation/btrfs-debug-tree.txt @@ -7,11 +7,11 @@ btrfs-debug-tree - dump btrfs filesystem metadata into stdout SYNOPSIS -------- -'btrfs-debug-tree' [options] +*btrfs-debug-tree* [options] DESCRIPTION ----------- -'btrfs-debug-tree' is used to dump the whole tree of the given device. +*btrfs-debug-tree* is used to dump the whole tree of the given device. This is maybe useful for analyzing filesystem state or inconsistence and has a positive educational effect on understanding the internal structure. @@ -30,7 +30,7 @@ Print info of the specified block only. EXIT STATUS ----------- -'btrfs-debug-tree' will return 0 if no error happened. +*btrfs-debug-tree* will return 0 if no error happened. If any problems happened, 1 will be returned. AUTHOR diff --git a/Documentation/btrfs-device.txt b/Documentation/btrfs-device.txt index 9cd8ad081a5a..4f847763bb66 100644 --- a/Documentation/btrfs-device.txt +++ b/Documentation/btrfs-device.txt @@ -7,12 +7,12 @@ btrfs-device - control btrfs devices SYNOPSIS -------- -'btrfs device' +*btrfs device* DESCRIPTION ----------- -'btrfs device' is used to control the btrfs devices, since btrfs can be used -across several devices, 'btrfs device' is used for multiple device management. +*btrfs device* is used to control the btrfs devices, since btrfs can be used +across several devices, *btrfs device* is used for multiple device management. DEVICE MANAGEMENT ----------------- @@ -62,7 +62,7 @@ See `btrfs-replace`(8) and this man page for more details. SUBCOMMAND ---------- -'add' [-Kf] [...] :: +*add* [-Kf] [...] :: Add device(s) to the filesystem identified by . + If applicable, a whole device discard (TRIM) operation is performed. @@ -74,10 +74,10 @@ do not perform discard by default -f|--force:::: force overwrite of existing filesystem on the given disk(s) -'delete' [...] :: +*delete* [...] :: Remove device(s) from a filesystem identified by . -'scan' [(--all-devices|-d)| [...]]:: +*scan* [(--all-devices|-d)| [...]]:: Scan devices for a btrfs filesystem. + If one or more devices are passed, these are scanned for a btrfs filesystem. @@ -86,10 +86,10 @@ filesystem as listed by blkid. Finally, if '--all-devices' or '-d' is passed, all the devices under /dev are scanned. -'ready' :: +*ready* :: Check device to see if it has all of it's devices in cache for mounting. -'stats' [-z] |:: +*stats* [-z] |:: Read and print the device IO stats for all devices of the filesystem identified by or for a single . + @@ -100,12 +100,12 @@ Reset stats to zero after reading them. EXIT STATUS ----------- -'btrfs device' returns a zero exist status if it succeeds. Non zero is +*btrfs device* returns a zero exist status if it succeeds. Non zero is returned in case of failure. AVAILABILITY ------------ -'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +*btrfs* is part of btrfs-progs. Btrfs filesystem is currently under heavy development, and not suitable for any uses other than benchmarking and review. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for diff --git a/Documentation/btrfs-filesystem.txt b/Documentation/btrfs-filesystem.txt index 63e3ef676cd3..e3e270ff0957 100644 --- a/Documentation/btrfs-filesystem.txt +++ b/Documentation/btrfs-filesystem.txt @@ -7,20 +7,20 @@ btrfs-filesystem - control btrfs filesystem SYNOPSIS -------- -'btrfs filesystem' +*btrfs filesystem* DESCRIPTION ----------- -'btrfs filesystem' is used to do the filesystem level control jobs, including +*btrfs filesystem* is used to do the filesystem level control jobs, including all the regular filesystem operations like setting/getting label, resizing, defragment. SUBCOMMAND ---------- -'df' [...]:: +*df* [...]:: Show space usage information for a mount point. -'show' [--mounted|--all-devices||||