From b3f39994082c6f1f9b4c073c085c0343873d044e Mon Sep 17 00:00:00 2001 From: Richard Littauer Date: Tue, 28 Jun 2016 10:49:09 +0100 Subject: [PATCH] Added note about error codes How does this look? See #2293 License: MIT Signed-off-by: Richard Littauer --- core/commands/root.go | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/core/commands/root.go b/core/commands/root.go index 29892ab0fbf..f9e6d8e9df9 100644 --- a/core/commands/root.go +++ b/core/commands/root.go @@ -66,6 +66,13 @@ ipfs uses a repository in the local file system. By default, the repo is located at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable: export IPFS_PATH=/path/to/ipfsrepo + +Error Codes + +The CLI will return a message and a code if it is accessed incorrectly. Code 1 +signifies that the CLI should return an exit code of 1 (and similarly 0 for +code 0). On POSIX systems, the standard convention is to pass '0' for a +successful execution, and '1' for a failed executions; ipfs follows this. `, }, Options: []cmds.Option{