From 39fb9b176a8dc381ff92e009f9934a2cb2aa5149 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Thu, 22 Oct 2015 01:40:34 +0200 Subject: [PATCH] update docs about return codes --- docs/usage.rst | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index 30e6f0914..6b88d5c60 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -22,19 +22,15 @@ Return codes :: - 0 no error, normal termination - 1 some error occurred (this can be a complete or a partial failure) - 128+N killed by signal N (e.g. 137 == kill -9) + 0 = success (logged as INFO) + 1 = warning (operation reached its normal end, but there were warnings - + you should check the log, logged as WARNING) + 2 = error (like a fatal error, a local or remote exception, the operation + did not reach its normal end, logged as ERROR) + 128+N = killed by signal N (e.g. 137 == kill -9) +The return code is also logged at the indicated level as the last log entry. -Note: we are aware that more distinct return codes might be useful, but it is -not clear yet which return codes should be used for which precise conditions. - -See issue #61 for a discussion about that. Depending on the outcome of the -discussion there, return codes may change in future (the only thing rather sure -is that 0 will always mean some sort of success and "not 0" will always mean -some sort of warning / error / failure - but the definition of success might -change). Environment Variables ---------------------