btrfs-progs: docs: document btrfs-balance exit status in detail

Signed-off-by: Vladimir Panteleev <git@vladimir.panteleev.md>
Signed-off-by: David Sterba <dsterba@suse.com>
master
Vladimir Panteleev 2019-08-25 06:02:56 +00:00 committed by David Sterba
parent 0889161127
commit ed2b4dc638
1 changed files with 10 additions and 2 deletions

View File

@ -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
------------