summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.cz>2015-01-03 02:12:56 +0100
committerDavid Sterba <dsterba@suse.cz>2015-01-03 02:30:38 +0100
commit38ce4bef83ae7678da7bb5581ae187b68daadfba (patch)
tree1eaacf585f0c2c805d6c70e362d6807930525299 /Documentation
parent963f2c0a47eeed7af2d62aaf6c4b52e11a955178 (diff)
btrfs-progs: doc, undocument old balance syntax
Standalone balance subcommand has been around since 3.3. Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/btrfs-balance.txt16
-rw-r--r--Documentation/btrfs.txt2
2 files changed, 10 insertions, 8 deletions
diff --git a/Documentation/btrfs-balance.txt b/Documentation/btrfs-balance.txt
index 27f0217e..6d2fd0c3 100644
--- a/Documentation/btrfs-balance.txt
+++ b/Documentation/btrfs-balance.txt
@@ -7,7 +7,7 @@ btrfs-balance - balance btrfs filesystem
SYNOPSIS
--------
-*btrfs [filesystem] balance* <subcommand>|<args>
+*btrfs balance* <subcommand> <args>
DESCRIPTION
-----------
@@ -16,14 +16,16 @@ multiple or even single device.
See `btrfs-device`(8) for more details about the effect on device management.
+NOTE: The balance subcommand also exists under the *filesystem* namespace. This
+still works for backward compatibility but is deprecated and should not be
+used anymore.
+
+NOTE: A short syntax *btrfs balance <path>* works due to backward compatibility
+but is deprecated and should not be used anymore. Use *btrfs balance start*
+command instead.
+
SUBCOMMAND
----------
-<path>::
-Balance chunks across the devices *online*.
-+
-*btrfs balance <path>* is deprecated,
-please use *btrfs balance start* command instead.
-
*cancel* <path>::
Cancel running or paused balance.
diff --git a/Documentation/btrfs.txt b/Documentation/btrfs.txt
index 4d2e101d..1b3aa293 100644
--- a/Documentation/btrfs.txt
+++ b/Documentation/btrfs.txt
@@ -29,7 +29,7 @@ detailed help of all the matched commands is showed. For example
COMMANDS
--------
-*[filesystem] balance*::
+*balance*::
Balance btrfs filesystem chunks across single or several devices. +
See `btrfs-balance`(8) for details.