You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -142,7 +142,7 @@ mbed CLI can create and import programs based on both mbed OS 2 and mbed OS 5.
142
142
143
143
### Creating a new program for mbed OS 5
144
144
145
-
When you create a new program, mbed CLI automatically imports the latest [mbed OS release](https://github.com/ARMmbed/mbed-os/). Each release includes all the components: code, build tools and IDE exporters.
145
+
When you create a new program, mbed CLI automatically imports the latest [mbed OS release](https://github.com/ARMmbed/mbed-os/). Each release includes all the components: code, build tools and IDE exporters.
146
146
147
147
With this in mind, let's create a new program (we'll call it `mbed-os-program`):
148
148
@@ -208,13 +208,13 @@ $ cd mbed-os-example-blinky
208
208
```
209
209
210
210
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:
While working on your code, you may need to add another library to your application or remove existing libraries.
239
+
While working on your code, you may need to add another library to your application or remove existing libraries.
240
240
241
241
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.
242
242
@@ -281,7 +281,7 @@ $ mbed remove text-lcd
281
281
After importing a program or creating a new one, you need to tell mbed CLI where to find the toolchains that you want to use for compiling your source tree.
282
282
283
283
There are multiple ways to configure toolchain locations:
284
-
*`mbed_settings.py` file in the root of your program. The tools will automatically create this file if it doesn't already exist.
284
+
*`mbed_settings.py` file in the root of your program. The tools will automatically create this file if it doesn't already exist.
285
285
* The mbed CLI configuration.
286
286
* Setting an environment variable.
287
287
* Adding directory of the compiler binary to your PATH.
@@ -293,10 +293,10 @@ Methods for configuring toolchains that appear earlier in the above list overrid
293
293
Edit `mbed_settings.py` to set your toolchain:
294
294
295
295
* To use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set `ARM_PATH` to the *base* directory of your ARM Compiler installation (example: C:\Program Files\ARM\armcc5.06). The recommended version of the ARM Compiler toolchain is 5.06.
296
-
* To use the [GNU ARM Embedded toolchain (GCC) version 6](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm/downloads), set `GCC_ARM_PATH` to the *binary* directory of your GCC ARM installation (example: C:\Program Files\GNU Tools ARM Embedded\6 2017q2\bin). Use version 6 of GCC ARM Embedded; version 5.0 or any older version might be incompatible with the tools.
297
-
* To use the [IAR EWARM toolhain](https://www.iar.com/iar-embedded-workbench/#!?architecture=ARM), set `IAR_PATH` to the *base* directory of your IAR installation. Use versions 7.80 of IAR EWARM; prior versions might be incompatible with the tools.
296
+
* To use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set `GCC_ARM_PATH` to the *binary* directory of your GCC ARM installation (example: C:\Program Files\GNU Tools ARM Embedded\6 2017q2\bin). Use version 6 of GCC ARM Embedded; version 5.0 or any older version might be incompatible with the tools.
297
+
* To use the [IAR EWARM toolchain](https://www.iar.com/iar-embedded-workbench/#!?architecture=ARM), set `IAR_PATH` to the *base* directory of your IAR installation (example: C:\Program Files (x86)\IAR Systems\Embedded Workbench 7.5\arm). Use version 7.80.x of the IAR EWARM; newer (or older) versions might be incompatible with the tools.
298
298
299
-
Because `mbed_settings.py` contains local settings (possibly relevant only to a single OS on a single machine), you should not check it into version control.
299
+
Because `mbed_settings.py` contains local settings (possibly relevant only to a single OS on a single machine), you should not check it into version control.
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.
654
+
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.
655
655
656
656
Here's an example:
657
657
@@ -677,7 +677,7 @@ You can then commit or discard these changes through that repository's version c
677
677
678
678
### Pushing upstream
679
679
680
-
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.
680
+
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.
681
681
682
682
Let's assume that the list of dependencies of your program (obtained by running `mbed ls`) looks like this:
683
683
@@ -696,12 +696,12 @@ Let's assume that you make changes to `iot-client`. `mbed publish` detects the c
696
696
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:
697
697
698
698
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.
699
-
1. Copy the URL/location of the new repository in your clipboard.
699
+
1. Copy the URL/location of the new repository in your clipboard.
700
700
1. Open command-line in the local repository directory (for example, change directory to `mbed-os-example/local-lib`).
701
701
1. To associate the local repository:
702
702
* For Git, run `git remote add origin <url-or-paht-to-your-remote-repo>`.
703
703
* For Mercurial, edit .hg/hgrc and add (or replace if exists):
704
-
704
+
705
705
```
706
706
[paths]
707
707
default = <url-or-paht-to-your-remote-repo>
@@ -725,7 +725,7 @@ Through the workflow explained above, mbed CLI maintains association to the orig
725
725
726
726
## Updating programs and libraries
727
727
728
-
You can update programs and libraries on your local machine so that they pull in changes from the remote sources (Git or Mercurial).
728
+
You can update programs and libraries on your local machine so that they pull in changes from the remote sources (Git or Mercurial).
729
729
730
730
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.
731
731
@@ -808,7 +808,7 @@ Here is a list of configuration settings and their defaults:
808
808
*`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`.
809
809
*`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.
810
810
*`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. Use `none` to turn caching off. Default: none (disabled).
811
-
811
+
812
812
## Troubleshooting
813
813
814
814
### Unable to import Mercurial (mbed.org) programs or libraries.
0 commit comments