From 38ce4bef83ae7678da7bb5581ae187b68daadfba Mon Sep 17 00:00:00 2001 From: David Sterba Date: Sat, 3 Jan 2015 02:12:56 +0100 Subject: [PATCH] btrfs-progs: doc, undocument old balance syntax Standalone balance subcommand has been around since 3.3. Signed-off-by: David Sterba --- Documentation/btrfs-balance.txt | 16 +++++++++------- Documentation/btrfs.txt | 2 +- 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* | +*btrfs balance* 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 * works due to backward compatibility +but is deprecated and should not be used anymore. Use *btrfs balance start* +command instead. + SUBCOMMAND ---------- -:: -Balance chunks across the devices *online*. -+ -*btrfs balance * is deprecated, -please use *btrfs balance start* command instead. - *cancel* :: 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.