extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2024-12-24 07:59:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix exit code docs - fixes #1169

Browse Source
This commit is contained in:
Nick Craig-Wood 2017-02-22 18:00:56 +00:00
parent 6b0f2ef4bd
commit f40443359d
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/content/docs.md
View File

@ -840,21 +840,22 @@ information.
Exit Code Exit Code
--------- ---------
If any errors occurred during the command, rclone with an exit code of If any errors occurred during the command, rclone will exit with a
`1`. This allows scripts to detect when rclone operations have failed. non-zero exit code. This allows scripts to detect when rclone
operations have failed.
During the startup phase rclone will exit immediately if an error is During the startup phase rclone will exit immediately if an error is
detected in the configuration. There will always be a log message detected in the configuration. There will always be a log message
immediately before exiting. immediately before exiting.
When rclone is running it will accumulate errors as it goes along, and When rclone is running it will accumulate errors as it goes along, and
only exit with an non-zero exit code if (after retries) there were no only exit with an non-zero exit code if (after retries) there were
transfers with errors remaining. For every error counted there will still failed transfers. For every error counted there will be a high
be a high priority log message (visibile with `-q`) showing the priority log message (visibile with `-q`) showing the message and
message and which file caused the problem. A high priority message is which file caused the problem. A high priority message is also shown
also shown when starting a retry so the user can see that any previous when starting a retry so the user can see that any previous error
error messages may not be valid after the retry. If rclone has done a messages may not be valid after the retry. If rclone has done a retry
retry it will log a high priority message if the retry was successful. it will log a high priority message if the retry was successful.
Environment Variables Environment Variables
--------------------- ---------------------