Merge pull request #237 from screamerbg/development

Improve documentation (0.8)

Author: sg-

README.md

@@ -34,6 +34,7 @@ This document covers the installation and usage of *mbed CLI*.
   2. [Change the test action](#change-the-test-action)
   3. [Limiting the test scope](#limiting-the-test-scope)
   4. [Test directory structure](#test-directory-structure)
+1. [mbed CLI configuration](#mbed-cli-configuration)
 1. [Known limitations](#known-limitations)
 
 ## Installation
@@ -62,6 +63,8 @@ You can get the latest stable version of *mbed CLI* via PyPI by running:
 $ pip install mbed-cli
 ```
 
+On Linux/Mac, you may need to run with `sudo`.
+
 Alternatively you get the development version of *mbed CLI* by cloning the development repository [https://github.com/ARMmbed/mbed-cli](https://github.com/ARMmbed/mbed-cli):
 
   `$ git clone https://github.com/ARMmbed/mbed-cli`
@@ -686,6 +689,31 @@ As shown above, tests exist inside ```TESTS\testgroup\testcase\``` directories.
 
 <span class="notes">**Note:** This feature does not work in applications that contain a  ```main``` function that is outside of a `TESTS` directory.</span>
 
+## mbed CLI configuration
+
+Many options in *mbed CLI* can be streamlined with global and local configuration.
+
+The *mbed CLI* configuration syntax is:
+```
+mbed config [--global] <var> [value] [--unset]
+```
+
+The **global** configuration (via `--global` option) defines the default behavior of *mbed CLI* across programs unless overridden by *local* settings.
+
+The **local** configuration (without `--global`) is per mbed program and allows overriding of global or default *mbed CLI* settings within the scope of a program or library and its dependencies.
+
+If **no value** is specified then *mbed CLI* will print the currently set value for this settings from either local or global scope.
+
+The `--unset` option allows removing of a setting.
+
+Here is a list of currently implemented configuration settings:
+ * `target` - Define default target for `compile`, `test` and `export`, and is an alias to `mbed target`. Default: none.
+ * `toolchain` - Defines default toolchain for `compile` and `test` can be set through `mbed toolchain`. Default: none.
+ * `ARM_PATH`, `GCC_ARM_PATH`, `IAR_PATH` - defines default path to ARM Compiler, GCC ARM and IAR Workbench toolchains. Default: none.
+ * `protocol` - Defines the default protocol used for importing/cloning of programs and libraries. Possible values are `https`, `http` and `ssh`. Use `ssh` if you have generated and registered SSH keys (Public Key Authentication) with a service like GitHub, GitLab, Bitbucket, etc. Read more about SSH keys [here](https://help.github.com/articles/generating-an-ssh-key/) Default: `https`.
+ * `depth` - Defines *clone* depth for importing/cloning and applies only to *Git* repositories. Note that while this option may improve cloning speed, it may also prevent you from correctly checking out a dependency tree when the reference revision hash is older than the clone depth. Read more about shallow clones [here](https://git-scm.com/docs/git-clone). Default: none.
+ * `cache` (EXPERIMENTAL) - Defines local path that will be used to store minimalistic copies of the imported/cloned repositories and attempt to use them to minimize traffic and speed up future importing. This feature is still under development, so this should not be used within a production environment. Default: none (disabled).
+
 ## Known limitations
 
 <span class="warnings">**Warning**: At this point, *mbed CLI* is alpha quality and very much in development. Breakages are fully expected. Please open issues on this repository for any problems that you find with *mbed CLI*.</span>

mbed/mbed.py

@@ -132,12 +132,12 @@ def action(msg):
 
 def warning(msg):
     for line in msg.splitlines():
-        sys.stderr.write("[mbed WARNING] %s\n" % line)
+        sys.stderr.write("[mbed] WARNING: %s\n" % line)
     sys.stderr.write("---\n")
 
 def error(msg, code=-1):
     for line in msg.splitlines():
-        sys.stderr.write("[mbed ERROR] %s\n" % line)
+        sys.stderr.write("[mbed] ERROR: %s\n" % line)
     sys.stderr.write("---\n")
     sys.exit(code)
 
@@ -2225,7 +2225,8 @@ def help_():
     else:
         error('OS Error: %s' % e[1], e[0])
 except KeyboardInterrupt as e:
-    error('User aborted!', 255)
+    log('User aborted!', -1)
+    sys.exit(255)
 except Exception as e:
     if very_verbose:
         traceback.print_exc(file=sys.stdout)