From ed2b4dc638bf6f43d40c3e42d9dfaa7d195951a5 Mon Sep 17 00:00:00 2001 From: Vladimir Panteleev Date: Sun, 25 Aug 2019 06:02:56 +0000 Subject: [PATCH] btrfs-progs: docs: document btrfs-balance exit status in detail Signed-off-by: Vladimir Panteleev Signed-off-by: David Sterba --- 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 ------------