diff --git a/README.md b/README.md index e70af393..db8afc7b 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ## Introduction -*mbed CLI* is the name of the ARM mbed command-line tool, packaged as mbed-cli, which enables the full mbed workflow: repositories version control, maintaining dependencies, publishing code, updating from remotely hosted repositories (GitHub, GitLab and mbed.org) and invoking ARM mbed's own build system and export functions, among other operations. +*mbed CLI* is the name of the ARM mbed command-line tool, packaged as `mbed-cli`, which enables the full mbed workflow. This document covers the installation and usage of mbed CLI. @@ -39,12 +39,12 @@ This document covers the installation and usage of mbed CLI. The basic workflow for mbed CLI is to: -1. Initialize a new repository, for either a new application (or library) or an imported one. In both cases, this action also brings in the mbed OS codebase. +1. Initialize a new repository, for either a new application (or library) or an imported one. In both cases, this action also adds the mbed OS codebase. 1. Build the application code. 1. Test your build. 1. Publish your application. -But mbed CLI goes much further than the basic workflow. To support long-term development, mbed CLI offers nuanced source control, including selective updates of libraries and the codebase, support for multiple toolchains and manual configuration of the system. +To support long-term development, mbed CLI offers source control, including selective updates of libraries and the codebase, support for multiple toolchains and manual configuration of the system. **Tip:** To list all mbed CLI commands, use `mbed --help`. A detailed command-specific help is available by using `mbed --help`. @@ -56,24 +56,23 @@ Windows, Linux and Mac OS X support mbed CLI. We're keen to learn about your exp * **Python** - mbed CLI is a Python script, so you'll need Python to use it. We test mbed CLI with [version 2.7.11 of Python](https://www.python.org/downloads/release/python-2711/). It is not compatible with Python 3. -* **Git and Mercurial** - mbed CLI supports both Git and Mercurial repositories, so you'll need to install both: +* **Git and Mercurial** - mbed CLI supports both Git and Mercurial repositories, so you need to install both: * [Git](https://git-scm.com/) - version 1.9.5 or later. * [Mercurial](https://www.mercurial-scm.org/) - version 2.2.2 or later. - **Note:** The directories of Git and Mercurial executables (`git` and `hg`) need to be in your system's PATH. +The directories of Git and Mercurial executables (`git` and `hg`) need to be in your system's PATH. -* **Command-line compiler or IDE toolchain** - mbed CLI invokes the [mbed OS 5](https://github.com/ARMmbed/mbed-os) tools for various features, such as compiling, testing and exporting to industry standard toolchains. To compile your code, you will need either a compiler or an IDE: +* **Command-line compiler or IDE toolchain** - mbed CLI invokes the [mbed OS 5](https://github.com/ARMmbed/mbed-os) tools for various features, such as compiling, testing and exporting to industry standard toolchains. To compile your code, you need either a compiler or an IDE: * Compilers: GCC ARM, ARM Compiler 5, IAR. * IDE: Keil uVision, DS-5, IAR Workbench. - ### Video tutorial for manual installation [![Video tutorial](http://img.youtube.com/vi/cM0dFoTuU14/0.jpg)](https://www.youtube.com/watch?v=cM0dFoTuU14) ### Installing mbed CLI -You can get the latest stable version of mbed CLI through PyPI by running: +You can get the latest stable version of mbed CLI through pip by running: ``` $ pip install mbed-cli @@ -99,7 +98,7 @@ On Linux or Mac, you may need to run with `sudo`. ### Uninstalling mbed CLI -To uninstall mbed CLI, simply run: +To uninstall mbed CLI, run: ``` pip uninstall mbed-cli @@ -119,11 +118,10 @@ $ cd mbed-os $ mbed update master # This will update "mbed-os", not "my-program" ``` -Various mbed CLI features require a program root, which whenever possible should be under version control - either [Git](https://git-scm.com/) or [Mercurial](https://www.mercurial-scm.org/). This makes it possible to seamlessly switch between revisions of the whole program and its libraries, control the program history, synchronize the program with remote repositories, share it with others and so on. Version control is also the primary and preferred delivery mechanism for mbed OS source code, which allows everyone to contribute to mbed OS. +Various mbed CLI features require a program root, which should be under version control - either [Git](https://git-scm.com/) or [Mercurial](https://www.mercurial-scm.org/). This makes it possible to switch between revisions of the whole program and its libraries, control the program history, synchronize the program with remote repositories, share it with others and so on. Version control is also the primary and preferred delivery mechanism for mbed OS source code, which allows everyone to contribute to mbed OS. **Warning**: mbed CLI stores information about libraries and dependencies in reference files that use the `.lib` extension (such as `lib_name.lib`). Although these files are human-readable, we *strongly* advise that you don't edit these manually - let mbed CLI manage them instead. - ## Creating and importing programs mbed CLI can create and import programs based on both mbed OS 2 and mbed OS 5. @@ -143,7 +141,7 @@ $ mbed new mbed-os-program This creates a new folder "mbed-os-program", initializes a new repository and imports the latest revision of the mbed-os dependency to your program tree. -**Tip:** You can control which source control management is used, or prevent source control management initialization, by using `--scm [name|none]` option. +**Tip:** You can instruct mbed CLI to use a specific source control management system or prevent source control management initialization, by using `--scm [name|none]` option. Use `mbed ls` to list all the libraries imported to your program: @@ -154,11 +152,11 @@ mbed-os-program (mbed-os-program) `- mbed-os (https://github.com/ARMmbed/mbed-os#89962277c207) ``` -**Note**: If you want to start from an existing folder in your workspace, you can simply use `mbed new .`, which will initialize an mbed program, as well as a new Git or Mercurial repository in that folder. +**Note**: If you want to start from an existing folder in your workspace, you can use `mbed new .`, which initializes an mbed program, as well as a new Git or Mercurial repository in that folder. ### Creating a new program for mbed OS 2 -mbed CLI is also compatible with mbed OS 2 programs based on the [mbed library](https://mbed.org/users/mbed_official/code/mbed/), and it will automatically import the latest [mbed library release](https://mbed.org/users/mbed_official/code/mbed/) if you use the `--mbedlib` option: +mbed CLI is also compatible with mbed OS 2 programs based on the [mbed library](https://mbed.org/users/mbed_official/code/mbed/), and it automatically imports the latest [mbed library release](https://mbed.org/users/mbed_official/code/mbed/) if you use the `--mbedlib` option: ``` $ mbed new mbed-classic-program --mbedlib @@ -169,6 +167,7 @@ $ mbed new mbed-classic-program --mbedlib [mbed] Updating reference "mbed" -> "https://mbed.org/users/mbed_official/code/mbed/builds/f9eeca106725" [mbed] Couldn't find build tools in your program. Downloading the mbed 2.0 SDK tools... ``` + ### Creating a new program without OS version selection You can create plain (empty) programs, without either mbed OS 5 or mbed OS 2, by using the `--create-only` option. @@ -194,7 +193,7 @@ $ mbed import https://mbed.org/teams/mbed/code/mbed_blinky/ $ cd mbed-os-example-blinky ``` -You can use the "import" command without specifying a full URL; a default prefix (https://github.com/ARMmbed) is added to the URL. For example, this command: +You can use the "import" command without specifying a full URL; mbed CLI adds a prefix (https://github.com/ARMmbed) to the URL if one is not present. For example, this command: ``` $ mbed import mbed-os-example-blinky @@ -223,12 +222,11 @@ $ mbed new . ## Adding and removing libraries -While working on your code, you may need to add another library (dependency) to your application, or remove existing libraries. +While working on your code, you may need to add another library to your application or remove existing libraries. -The mbed CLI add and remove features aren't simply built-in versions of ``hg``, ``git`` and ``rm``; their functionality is tailored to the way mbed OS and mbed CLI work: +Adding a new library to your program is not the same as cloning the repository. Don't clone a library using `hg` or `git`; use `mbed add` to add the library. This ensures that all libraries and sublibraries are populated as well. -* Adding a new library to your program is not the same as just cloning the repository. Don't clone a library using `hg` or `git`; use `mbed add` to add the library. This ensures that all dependencies - libraries or sublibraries - are populated as well. -* Removing a library from your program is not the same as deleting the library directory - there are library reference files that will need updating or cleaning. Use `mbed remove` to remove the library; don't simply remove its directory with `rm`. +Removing a library from your program is not the same as deleting the library directory. mbed CLI updates and removes library reference files. Use `mbed remove` to remove the library; don't remove its directory with `rm`. ### Adding a library @@ -238,13 +236,13 @@ Use `mbed add` to add the latest revision of a library: $ mbed add https://developer.mbed.org/users/wim/code/TextLCD/ ``` -Use the URL#hash format to add a library at a specific revision: +Use the `URL#hash` format to add a library from a URL at a specific revision hash: ``` $ mbed add https://developer.mbed.org/users/wim/code/TextLCD/#e5a0dcb43ecc ``` -___Specifying a destination directory___ +#### Specifying a destination directory If you want to specify a directory to which to add your library, you can give an additional argument to ``add``, which names that directory. For example, If you'd rather add the previous library in a directory called "text-lcd" (instead of TextLCD): @@ -252,7 +250,7 @@ If you want to specify a directory to which to add your library, you can give an $ mbed add https://developer.mbed.org/users/wim/code/TextLCD/ text-lcd ``` -Although mbed CLI supports this functionality, we don't encourage it - adding a library with a name that differs from its source repository can easily lead to confusion. +Although mbed CLI supports this functionality, we don't encourage it. Adding a library with a name that differs from its source repository can lead to confusion. ### Removing a library @@ -344,26 +342,26 @@ Image: BUILD/K64F/GCC_ARM/mbed-os-program.bin The arguments for *compile* are: -* `-m ` to select a target. If `detect` or `auto` parameter is passed, then mbed CLI will attempt to detect the connected target and compile against it. -* `-t ` to select a toolchain (of those defined in `mbed_settings.py`, see above). The value can be `ARM` (ARM Compiler 5), `GCC_ARM` (GNU ARM Embedded), or `IAR` (IAR Embedded Workbench for ARM). +* `-m ` to select a target. If `detect` or `auto` parameter is passed to `-m`, then mbed CLI detects the connected target. +* `-t ` to select a toolchain (of those defined in `mbed_settings.py`, see above). The value can be `ARM` (ARM Compiler 5), `GCC_ARM` (GNU ARM Embedded) or `IAR` (IAR Embedded Workbench for ARM). * `--source ` to select the source directory. The default is `.` (the current directory). You can specify multiple source locations, even outside the program tree. -* `--build ` to select the build directory. Default: `BUILD/` inside your program. +* `--build ` to select the build directory. Default: `BUILD/` inside your program root. * `--profile ` to select a path to a build profile configuration file. Example: mbed-os/tools/profiles/debug.json. * `--library` to compile the code as a [static .a/.ar library](#compiling-static-libraries). * `--config` to inspect the runtime compile configuration (see below). * `-S` or `--supported` shows a matrix of the supported targets and toolchains. -* `-c ` (optional) to build from scratch; a clean build or rebuild. -* `-j ` (optional) to control the compile threads on your machine. The default value is 0, which infers the number of threads from the number of cores on your machine. You can use `-j 1` to trigger a sequential compile of source code. +* `-c ` to build from scratch, a clean build or rebuild. +* `-j ` to control the compile processes on your machine. The default value is 0, which infers the number of processes from the number of cores on your machine. You can use `-j 1` to trigger a sequential compile of source code. * `-v` or `--verbose` for verbose diagnostic output. * `-vv` or `--very_verbose` for very verbose diagnostic output. -The compiled binary, ELF image, memory usage and link statistics can be found in the `build` subdirectory of your program. +You can find the compiled binary, ELF image, memory usage and link statistics in the `BUILD` subdirectory of your program. -For more information on build profiles see https://github.com/ARMmbed/mbed-os/blob/master/docs/Toolchain_Profiles.md . +For more information on build profiles, see [our build profiles](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/dev_tools/build_profiles/) and [toolchain profiles](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/advanced/toolchain_profiles/) pages. ### Compiling static libraries -You can build a static library of your code by adding the `--library` argument to `mbed compile`. Static libraries are useful when you want to build multiple applications from the same mbed-os codebase without having to recompile for every application. To achieve this: +You can build a static library of your code by adding the `--library` argument to `mbed compile`. Static libraries are useful when you want to build multiple applications from the same mbed OS codebase without having to recompile for every application. To achieve this: 1. Build a static library for mbed-os. 2. Compile multiple applications or tests against the static library: @@ -391,11 +389,11 @@ Image: ../threaded_blinky-out/threaded_blinky.bin ### Compile configuration system -The [compile configuration system](https://docs.mbed.com/docs/mbed-os-handbook/en/5.3/advanced/config_system/) provides a flexible mechanism for configuring the mbed program, its libraries and the build target. Refer to the previous link for more details about the configuration system. +The [compile configuration system](https://docs.mbed.com/docs/mbed-os-handbook/en/5.3/advanced/config_system/) provides a flexible mechanism for configuring the mbed program, its libraries and the build target. -___Inspecting the configuration___ +#### Inspecting the configuration -If the program uses the [compile configuration system](https://docs.mbed.com/docs/mbed-os-handbook/en/latest/advanced/config_system/), you can use `mbed compile --config` to view the configuration: +You can use `mbed compile --config` to view the configuration: ``` $ mbed compile --config -t GCC_ARM -m K64F @@ -407,14 +405,13 @@ To display more verbose information about the configuration parameters, use `-v` $ mbed compile --config -t GCC_ARM -m K64F -v ``` -It's possible to filter the output of `mbed compile --config` by specifying one or more prefixes for the configuration parameters that will be displayed. For example, to display only the configuration defined by the targets: +It's possible to filter the output of `mbed compile --config` by specifying one or more prefixes for the configuration parameters that mbed CLI displays. For example, to display only the configuration defined by the targets: ``` $ mbed compile --config -t GCC_ARM -m K64F --prefix target ``` -`--prefix` can be used more than once. To display only the configuration defined by the application and the targets, use two `--prefix` options: - +You may use `--prefix` more than once. To display only the application and target configuration, use two `--prefix` options: ``` $ mbed compile --config -t GCC_ARM -m K64F --prefix target --prefix app @@ -422,7 +419,7 @@ $ mbed compile --config -t GCC_ARM -m K64F --prefix target --prefix app ### Compile-time customizations -___Macros___ +#### Macros You can specify macros in your command-line using the -D option. For example: @@ -430,27 +427,26 @@ You can specify macros in your command-line using the -D option. For example: $ mbed compile -t GCC_ARM -m K64F -c -DUVISOR_PRESENT ``` -___Compiling in debug mode___ +#### Compiling in debug mode -To compile in debug mode (as opposed to the default *release* mode), use `--profile mbed-os/tools/profiles/debug.json` in the compile command-line: +To compile in debug mode (as opposed to the default *develop* mode), use `--profile mbed-os/tools/profiles/debug.json` in the compile command-line: ``` $ mbed compile -t GCC_ARM -m K64F --profile mbed-os/tools/profiles/debug.json ``` -**Tip:** If you have files that you want to compile only in release mode, put them in a directory called `TARGET_RELEASE` at any level of your tree. If you have files that you want to compile only in debug mode, put them in a directory called `TARGET_DEBUG` at any level of your tree (then use `--profile` as explained above). +**Tip:** If you have files that you want to compile only in debug mode, put them in a directory called `TARGET_DEBUG` at any level of your tree (then use `--profile` as explained above). ### Automating toolchain and target selection -Using `mbed target ` and `mbed toolchain `, you can set the default target and toolchain for your program, meaning you won't have to specify these every time you compile or generate IDE project files. - -You can also use ``mbed target detect``, which will attempt to detect the connected target board and use it as parameter every time you compile or export. +Using `mbed target ` and `mbed toolchain `, you can set the default target and toolchain for your program. You won't have to specify these every time you compile or generate IDE project files. +You can also use ``mbed target detect``, which detects the connected target board and uses it as a parameter to every subsequent compile and export. ## Exporting to desktop IDEs -If you need to debug your code, a good way to do that is to export your source tree to an IDE project file, so you can use the IDE's debugging facilities. Currently mbed CLI supports exporting to Keil uVision, DS-5, IAR Workbench, Simplicity Studio and other IDEs. +If you need to debug your code, you can export your source tree to an IDE project file to use the IDE's debugging facilities. mbed CLI supports exporting to Keil uVision, IAR Workbench, a Makefile using GCC ARM, Eclipse using GCC ARM and other IDEs. For example, to export to uVision, run: @@ -458,11 +454,29 @@ For example, to export to uVision, run: $ mbed export -i uvision -m K64F ``` -A `.uvproj` file is created in the projectfiles/uvision folder. You can open the project file with uVision. +mbed CLI creates a `.uvprojx` file in the projectfiles/uvision folder. You can open the project file with uVision. ## Testing -Use the `mbed test` command to compile and run tests: +Use the `mbed test` command to compile and run tests. + +The arguments to `test` are: +* `-m ` to select a target for the compilation. If `detect` or `auto` parameter is passed, then mbed CLI will attempt to detect the connected target and compile against it. +* `-t ` to select a toolchain (of those defined in `mbed_settings.py`, see above), where `toolchain` can be either `ARM` (ARM Compiler 5), `GCC_ARM` (GNU ARM Embedded), or `IAR` (IAR Embedded Workbench for ARM). +* `--compile-list` to list all the tests that can be built. +* `--run-list` to list all the tests that can be run (they must be built first). +* `--compile` to only compile the tests. +* `--run` to only run the tests. +* `-n ` to limit the tests built or run to a comma separated list (ex. test1,test2,test3). +* `--source ` to select the source directory. Default is `.` (the current directory). You can specify multiple source locations, even outside the program tree. +* `--build ` to select the build directory. Default: `BUILD/` inside your program. +* `--profile ` to select a path to a build profile configuration file. Example: mbed-os/tools/profiles/debug.json. +* `-c or --clean` to clean the build directory before compiling. +* `--test-spec ` to set the path for the test spec file used when building and running tests (the default path is the build directory). +* `-v` or `--verbose` for verbose diagnostic output. +* `-vv` or `--very_verbose` for very verbose diagnostic output. + +Invoke `mbed test`: ``` $ mbed test -m K64F -t GCC_ARM @@ -504,22 +518,6 @@ mbedgt: test case results: 3 OK mbedgt: completed in 21.28 sec ``` -The arguments to `test` are: -* `-m ` to select a target for the compilation. If `detect` or `auto` parameter is passed, then mbed CLI will attempt to detect the connected target and compile against it. -* `-t ` to select a toolchain (of those defined in `mbed_settings.py`, see above), where `toolchain` can be either `ARM` (ARM Compiler 5), `GCC_ARM` (GNU ARM Embedded), or `IAR` (IAR Embedded Workbench for ARM). -* `--compile-list` to list all the tests that can be built. -* `--run-list` to list all the tests that can be run (they must be built first). -* `--compile` to only compile the tests. -* `--run` to only run the tests. -* `-n ` to limit the tests built or run to a comma separated list (ex. test1,test2,test3). -* `--source ` to select the source directory. Default is `.` (the current directory). You can specify multiple source locations, even outside the program tree. -* `--build ` to select the build directory. Default: `BUILD/` inside your program. -* `--profile ` to select a path to a build profile configuration file. Example: mbed-os/tools/profiles/debug.json. -* `-c or --clean` to clean the build directory before compiling. -* `--test-spec ` to set the path for the test spec file used when building and running tests (the default path is the build directory). -* `-v` or `--verbose` for verbose diagnostic output. -* `-vv` or `--very_verbose` for very verbose diagnostic output. - You can find the compiled binaries and test artifacts in the `BUILD/tests//` directory of your program. #### Finding available tests @@ -569,7 +567,7 @@ If you don't specify any of these, `mbed test` will first compile all available #### Limiting the test scope -You can limit the scope of the tests built and run by using the `-n` option. This takes a comma separated list of test names as an argument: +You can limit the scope of the tests built and run by using the `-n` option. This takes a comma-separated list of test names as an argument: ``` $ mbed test -m K64F -t GCC_ARM -n TESTS-functional-test1,TESTS-functional-test2 @@ -581,12 +579,11 @@ You can use the wildcard character `*` to run a group of tests that share a comm $ mbed test -m NUCLEO_F429ZI -t GCC_ARM -n TESTS-functional* ``` -**Note:** Some shells will try to expand the wildcard character `*` into file names that exist in your working directory. To prevent this behavior, please see your shell's documentation. - +**Note:** Some shells expand the wildcard character `*` into file names that exist in your working directory. To prevent this behavior, please see your shell's documentation. ### Test directory structure -Test code exists in the following directory structure: +Test code must follow this directory structure: ``` mbed-os-program @@ -615,15 +612,15 @@ mbed-os-program | .... ``` -As shown above, tests exist inside ```TESTS\testgroup\testcase\``` directories. Please note that `TESTS` is a special upper case directory that is excluded from module sources while compiling. +As shown above, tests exist inside `TESTS\testgroup\testcase\` directories. Please note that `TESTS` is a special upper case directory that is excluded from module sources while compiling. -**Note:** This feature does not work in applications that contain a ```main``` function that is outside of a `TESTS` directory. +**Note:** `mbed test` does not work in applications that contain a `main` function that is outside of a `TESTS` directory. ## Publishing your changes ### Checking status -As you develop your program, you'll edit parts of it - either your own code or code in some of the libraries that it depends on. You can get the status of all the repositories in your program (recursively) by running `mbed status`. If a repository has uncommitted changes, this command will display these changes. +As you develop your program, you'll edit parts of it. You can get the status of all the repositories in your program (recursively) by running `mbed status`. If a repository has uncommitted changes, this command displays these changes. Here's an example: @@ -645,13 +642,13 @@ Here's an example: M source/include/static_config.h ``` -You can then commit or discard these changes. +You can then commit or discard these changes through that repository's version control system. ### Pushing upstream -To push the changes in your local tree upstream, run `mbed publish`. `publish` works recursively, pushing the leaf dependencies first, then updating the dependents and pushing them too. +To push the changes in your local tree upstream, run `mbed publish`. `mbed publish` works recursively, pushing the leaf dependencies first, then updating the dependents and pushing them too. -This is best explained by an example. Let's assume that the list of dependencies of your program (obtained by running `mbed ls`) looks like this: +Let's assume that the list of dependencies of your program (obtained by running `mbed ls`) looks like this: ``` my-mbed-os-example (a5ac4bf2e468) @@ -661,123 +658,99 @@ my-mbed-os-example (a5ac4bf2e468) `- my-libs/test-framework (cd18b5a50df4) ``` -Let's assume that you make changes to `iot-client`. `publish` detects the change on the leaf `iot-client` dependency and asks you to commit it. Then it detects that `my-libs` depends on `iot-client`, updates the `my-libs` dependency on `iot-client` to its latest version (by updating the `iot-client.lib` file) and asks you to commit it. This propagates up to `my-libs` and finally to your program `my-mbed-os-example`. +Let's assume that you make changes to `iot-client`. `mbed publish` detects the change on the leaf `iot-client` dependency and asks you to commit it. Then `mbed publish` detects that `my-libs` depends on `iot-client`, updates the `my-libs` dependency on `iot-client` to its latest version by updating the `iot-client.lib` file and asks you to commit it. This propagates up to `my-libs` and finally to your program, `my-mbed-os-example`. ## Publishing a local program or library -When you create a new (local) source-control managed program or library, its revision history exists only locally; the repository is not associated with the remote one. To publish the local repository without losing its revision history, please follow these steps: +When you create a new (local) version control managed program or library, its revision history exists only locally. The repository is not associated with the remote one. To publish the local repository, please follow these steps: -1. Create a new empty repository on the remote site. This can be based on a public repository hosting service (GitHub, Bitbucket, mbed.org), your own service or even a different location on your system. -2. Copy the URL/location of the new repository in your clipboard and open command-line in the local repository directory (for example change directory to `mbed-os-example/local-lib`). -3. To associate the local repository: - * For Git - run `git remote add origin `. - * For Mercurial - edit .hg/hgrc and add (or replace if exists): +1. Create a new empty repository on the remote site. This can be on a public repository hosting service (GitHub, Bitbucket, mbed.org), your own service or a different location on your system. +1. Copy the URL/location of the new repository in your clipboard. +1. Open command-line in the local repository directory (for example, change directory to `mbed-os-example/local-lib`). +1. To associate the local repository: + * For Git, run `git remote add origin `. + * For Mercurial, edit .hg/hgrc and add (or replace if exists): ``` [paths] default = ``` -4. Run `mbed publish` to publish your changes. + +1. Run `mbed publish` to publish your changes. In a scenario with nested local repositories, start with the leaf repositories first. ### Forking workflow -Git enables asymmetric workflow where the publish/push repository may be different than the original ("origin") one. This allows new revisions to land in a fork repository while maintaining an association with the original repository. - -To achieve this, first import an mbed OS program or mbed OS itself and then associate the push remote with your fork. For example: +Git enables a workflow where the publish/push repository may be different than the original ("origin") one. This allows new revisions in a fork repository while maintaining an association with the original repository. To use this workflow, first import an mbed OS program or mbed OS itself, and then associate the push remote with your fork. For example: ``` $ git remote set-url --push origin https://github.com/screamerbg/repo-fork ``` -Each time you `git` commit and push, or use `mbed publish`, the new revisions will be pushed against your fork. You can fetch from the original repository using `mbed update` or `git pull`. If you explicitly want to fetch or pull from your fork, then you can use `git pull https://github.com/screamerbg/repo-fork [branch]`. +Both `git commit & git push` and `mbed publish` push the new revisions to your fork. You can fetch from the original repository using `mbed update` or `git pull`. If you explicitly want to fetch or pull from your fork, then you can use `git pull https://github.com/screamerbg/repo-fork [branch]`. -Through the workflow explained above, mbed CLI will maintain association to the original repository (which you may want to send a pull request to) and will record references with the revision hashes that you push to your fork. Until your pull request (PR) is accepted, all recorded references will be invalid. Once the PR is accepted, all revision hashes from your fork will become part the original repository, so all references will become valid. +Through the workflow explained above, mbed CLI maintains association to the original repository (which you may want to send a pull request to) and will record references with the revision hashes that you push to your fork. Until your pull request (PR) is accepted, all recorded references are invalid. Once the PR is accepted, all revision hashes from your fork become part the original repository, making them valid. ## Updating programs and libraries -You can update programs and libraries on your local machine so that they pull in changes from the remote sources (GitHub or Mercurial). - -There are two main scenarios when updating: - -* Update to a *moving* revision, such as the tip of a branch. -* Update to a *specific* revision that is identified by a revision hash or tag name. - -Each scenario has two cases: +You can update programs and libraries on your local machine so that they pull in changes from the remote sources (Git or Mercurial). -* Update with local uncommitted changes - *dirty* update. -* Update without local uncommitted changes - *clean* update. +As with any mbed CLI command, `mbed update` uses the current directory as a working context. Before calling `mbed update`, you should change your working directory to the one you want to update. For example, if you're updating mbed-os, use `cd mbed-os` before you begin updating. -As with any mbed CLI command, `mbed update` uses the current directory as a working context, meaning that before calling `mbed update`, you should change your working directory to the one you want to update. For example, if you're updating mbed-os, use `cd mbed-os` before you begin updating. - -**Tip: Synchronizing library references:** Before triggering an update, you may want to synchronize any changes that you've made to the program structure by running ``mbed sync``, which will update the necessary library references and get rid of the invalid ones. +**Tip: Synchronizing library references:** Before triggering an update, you may want to synchronize any changes that you've made to the program structure by running ``mbed sync``, which updates the necessary library references and removes the invalid ones. ### Protection against overwriting local changes -The update command will fail if there are changes in your program or library that `update` could overwrite. This is by design: mbed CLI does not run operations that would result in overwriting local changes that are not yet committed. If you get an error, take care of your local changes (commit or use one of the options below), then rerun `update`. +The update command fails if there are changes in your program or library that `mbed update` could overwrite. This is by design. mbed CLI does not run operations that would result in overwriting uncommitted local changes. If you get an error, take care of your local changes (commit or use one of the options below), and then rerun `mbed update`. ### Updating to an upstream version -___Updating a program___ +#### Updating a program -To update your program to another upstream version, go to the root folder of the program and run: +To update your program to another upstream version, go to the root folder of the program, and run: ``` $ mbed update [branch|tag|revision] ``` -This fetches new revisions from the remote repository, updating the program to the specified branch, tag or revision. If none of these are specified, then it updates to the latest revision in the current branch. This series of actions is performed recursively against all dependencies and subdependencies in the program tree. +This fetches new revisions from the remote repository, updating the program to the specified branch, tag or revision. If you don't specificy any of these, then `mbed update` updates to the latest revision of the current branch. `mbed update` performs this series of actions recursively against all dependencies in the program tree. -___Updating a library___ +#### Updating a library You can change the working directory to a library folder and use `mbed update` to update that library and its dependencies to a different revision than the one referenced in the parent program or library. This allows you to experiment with different versions of libraries/dependencies in the program tree without having to change the parent program or library. -### Update examples - -To help understand what options you can use with mbed CLI, check the examples below. - -**Case 1: I want to update a program or a library to the latest version in a specific or current branch** - -__I want to preserve my uncommitted changes__ - -Run `mbed update [branch]`. You might have to commit or stash your changes if the source control tool (Git or Mercurial) throws an error that the update will overwrite local changes. - -__I want a clean update (and discard uncommitted changes)__ +There are three additional options that modify how unpublished local libraries are handled: -Run `mbed update [branch] --clean` +* `mbed update --clean-deps` - Update the current program or library and its dependencies, and discard all local unpublished repositories. Use this with caution because your local unpublished repositories cannot be restored unless you have a backup copy. -Specifying a branch to `mbed update` will only check out that branch and won't automatically merge or fast-forward to the remote/upstream branch. You can run `mbed update` to merge (fast-forward) your local branch with the latest remote branch. On Git you can do `git pull`. +* `mbed update --clean-files` - Update the current program or library and its dependencies, discard local uncommitted changes and remove any untracked or ignored files. Use this with caution because your local unpublished repositories cannot be restored unless you have a backup copy. -**Warning**: The `--clean` option tells mbed CLI to update that program or library and its dependencies and discard all local changes. This action cannot be undone; use with caution. +* `mbed update --ignore` - Update the current program or library and its dependencies, and ignore any local unpublished libraries (they won't be deleted or modified, just ignored). -**Case 2: I want to update a program or a library to a specific revision or a tag** - -__I want to preserve my uncommitted changes__ +### Update examples -Run `mbed update `. You might have to commit or stash your changes if they conflict with the latest revision. +There are two main scenarios when updating: -__I want a clean update (discard changes)__ +* Update with local uncommitted changes: *dirty* update. -Run `mbed update --clean` +Run `mbed update [branch|revision|tag_name]`. You might have to commit or stash your changes if the source control tool (Git or Mercurial) throws an error that the update will overwrite local changes. -__When you have unpublished local libraries__ +* Discard local uncommitted changes: *clean* update. -There are three additional options that modify how unpublished local libraries are handled: +Run `mbed update [branch|revision|tag_name] --clean` -* `mbed update --clean-deps` - update the current program or library and its dependencies and discard all local unpublished repositories. Use this with caution because your local unpublished repositories cannot be restored unless you have a backup copy. - -* `mbed update --clean-files` - update the current program or library and its dependencies, discard local uncommitted changes and remove any untracked or ignored files. Use this with caution because your local unpublished repositories cannot be restored unless you have a backup copy. +Specifying a branch to `mbed update` will only check out that branch and won't automatically merge or fast-forward to the remote/upstream branch. You can run `mbed update` to merge (fast-forward) your local branch with the latest remote branch. On Git you can do `git pull`. -* `mbed update --ignore` - update the current program or library and its dependencies and ignore any local unpublished libraries (they won't be deleted or modified, just ignored). +**Warning**: The `--clean` option tells mbed CLI to update that program or library and its dependencies and discard all local changes. This action cannot be undone; use with caution. -__Combining update options__ +#### Combining update options -You can combine the options above for the following scenarios: +You can combine the options of the mbed update command for the following scenarios: -* `mbed update --clean --clean-deps --clean-files` - update the current program or library and its dependencies, remove all local unpublished libraries, discard local uncommitted changes and remove all untracked or ignored files. This wipes every single change that you made in the source tree and restores the stock layout. +* `mbed update --clean --clean-deps --clean-files` - Update the current program or library and its dependencies, remove all local unpublished libraries, discard local uncommitted changes and remove all untracked or ignored files. This wipes every single change that you made in the source tree and restores the stock layout. -* `mbed update --clean --ignore` - update the current program or library and its dependencies, but ignore any local repositories. mbed CLI will update whatever it can from the public repositories. +* `mbed update --clean --ignore` - Update the current program or library and its dependencies, but ignore any local repositories. mbed CLI will update whatever it can from the public repositories. Use these with caution because your uncommitted changes and unpublished libraries cannot be restored. @@ -791,26 +764,26 @@ mbed config [--global] [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 the local or global scope. -* The `--unset` option allows removing of a setting. +* The **local** configuration (without `--global`) is specific to mbed program and allows overriding of global or default mbed CLI settings. +* If you do not specify a value, then mbed CLI prints the value for this setting in this context. +* The `--unset` option allows you to remove a setting. * The `--list` option allows you to list global and local configuration. -Here is a list of currently implemented configuration settings: +Here is a list of configuration settings and their defaults: * `target` - defines the default target for `compile`, `test` and `export`; an alias of `mbed target`. Default: none. * `toolchain` - defines the default toolchain for `compile` and `test`; can be set through `mbed toolchain`. Default: none. - * `ARM_PATH`, `GCC_ARM_PATH`, `IAR_PATH` - defines the default path to ARM Compiler, GCC ARM and IAR Workbench toolchains. Default: none. - * `protocol` - defines the default protocol used for importing or cloning of programs and libraries. The possible values are `https`, `http` and `ssh`. Use `ssh` if you have generated and registered SSH keys (Public Key Authentication) with a service such as GitHub, GitLab, Bitbucket, etc. Read more about SSH keys [here](https://help.github.com/articles/generating-an-ssh-key/). Default: `https`. + * `ARM_PATH`, `GCC_ARM_PATH`, `IAR_PATH` - defines the path to ARM Compiler, GCC ARM and IAR Workbench toolchains. Default: none. + * `protocol` - defines the default protocol used for importing or cloning of programs and libraries. The possible values are `https`, `http` and `ssh`. Use `ssh` if you have generated and registered SSH keys (Public Key Authentication) with a service such as GitHub, GitLab, Bitbucket and so on. Read more about SSH keys [here](https://help.github.com/articles/generating-an-ssh-key/). Default: `https`. * `depth` - defines the *clone* depth for importing or cloning and applies only to *Git* repositories. Note that though 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` - defines the local path that will be used to store minimalistic copies of the imported or cloned repositories, and attempts to use it to minimize traffic and speed up future imports of the same repositories. Use `on` or `enabled` to turn on caching in the system temp path. Default: none (disabled). + * `cache` - defines the local path that stores small copies of the imported or cloned repositories, and mbed CLI uses it to minimize traffic and speed up future imports of the same repositories. Use `on` or `enabled` to turn on caching in the system temp path. Default: none (disabled). ## Troubleshooting -#### Unable to import Mercurial based (mbed.org) programs or libraries. -1. Check whether you have Mercurial installed in your system path by running `hg` in command prompt. If you're receiving "command not found" or similar message, then you need to install Mercurial and add it to your system path. +### Unable to import Mercurial (mbed.org) programs or libraries. +1. Check whether you have Mercurial installed in your system path by running `hg` in command prompt. If you're receiving "command not found" or a similar message, then you need to install Mercurial, and add it to your system path. -2. Try to clone a Mercurial repository directly, e.g. `hg clone https://developer.mbed.org/teams/mbed/code/mbed_blinky/`. If you're receiving error similar to `abort: error: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.:590)`, then your system certificates are very old. You need to update your system certificates and possibly add the host certificate fingerprint of `mbed.com` and `mbed.org`. Read more about Mercurial's certificate management [here](https://www.mercurial-scm.org/wiki/CACertificates). +2. Try to clone a Mercurial repository directly. For example, `hg clone https://developer.mbed.org/teams/mbed/code/mbed_blinky/`. If you receive an error similar to `abort: error: [SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed (_ssl.:590)`, then your system certificates are out of date. You need to update your system certificates and possibly add the host certificate fingerprint of `mbed.com` and `mbed.org`. Read more about Mercurial's certificate management [here](https://www.mercurial-scm.org/wiki/CACertificates). -#### Various issues when running mbed CLI in Cygwin environment +### Various issues when running mbed CLI in Cygwin environment Currently mbed CLI is not compatible with Cygwin environment and cannot be executed inside it (https://github.com/ARMmbed/mbed-cli/issues/299).