[PATCH 0/1] btrfs-progs: docs: document btrfs-balance exit status in detail

[PATCH 0/1] btrfs-progs: docs: document btrfs-balance exit status in detail

[Vladimir Panteleev]

The `balance status` exit code is a bit of a mess, and the opposite of
pause/cancel/resume. I assume it's too late to fix it, so documenting
it is the best we can do.

Vladimir Panteleev (1):
  btrfs-progs: docs: document btrfs-balance exit status in detail

 Documentation/btrfs-balance.asciidoc | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

-- 
2.23.0

[PATCH 1/1] btrfs-progs: docs: document btrfs-balance exit status in detail

[Vladimir Panteleev]

Signed-off-by: Vladimir Panteleev <git@vladimir.panteleev.md>
---
 Documentation/btrfs-balance.asciidoc | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/Documentation/btrfs-balance.asciidoc b/Documentation/btrfs-balance.asciidoc
index bfb76742..8afd76da 100644
--- a/Documentation/btrfs-balance.asciidoc
+++ b/Documentation/btrfs-balance.asciidoc
@@ -354,8 +354,16 @@ This should lead to decrease in the 'total' numbers in the *btrfs filesystem df*
 
 EXIT STATUS
 -----------
-*btrfs balance* returns a zero exit status if it succeeds. Non zero is
-returned in case of failure.
+Unless indicated otherwise below, all *btrfs balance* subcommands
+return a zero exit status if they succeed, and non zero in case of
+failure.
+
+The *pause*, *cancel*, and *resume* subcommands exit with a status of
+*2* if they fail because a balance operation was not running.
+
+The *status* subcommand exits with a status of *0* if a balance
+operation is not running, *1* if the command-line usage is incorrect
+or a balance operation is still running, and *2* on other errors.
 
 AVAILABILITY
 ------------
-- 
2.23.0

Re: [PATCH 0/1] btrfs-progs: docs: document btrfs-balance exit status in detail

[David Sterba]

On Sun, Aug 25, 2019 at 06:02:55AM +0000, Vladimir Panteleev wrote:
> The `balance status` exit code is a bit of a mess, and the opposite of
> pause/cancel/resume. I assume it's too late to fix it, so documenting
> it is the best we can do.

Unfortunatelly, it is. Applied, thanks.