Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Initial Docker page
  • Loading branch information
Donatien Garnier authored and saheerb committed Sep 7, 2021
commit 1b5cb6ca198e01571b16e6e5bd6e1a1e512fbce7
6 changes: 6 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1127,6 +1127,12 @@
}
]
},
{
"title": "Docker",
"sources": [{
"path": "docs/tools/docker/docker.md"
}]
},
{
"title": "Third-party build tools",
"sources": [{
Expand Down
47 changes: 47 additions & 0 deletions docs/tools/docker/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Docker use in Mbed OS

The easiest and quickest way to get a build environment setup for Mbed OS projects is through the use of Docker.

We maintain an Mbed OS image which includes the following tooling:
* Arm Embedded GCC Toolchain
* CMake
* Mbed CLI 2
* Greentea
* PyOCD

Our image is maintained [on GitHub](https://github.com/ARMmbed/mbed-os-docker-images) and [is open for contributions](https://github.com/ARMmbed/mbed-os-docker-images/pulls).

<span class="notes">**Note:** Our Docker image leverages Mbed CLI 2, so only supports projects built with Mbed OS 6.4 or more recent.</span>

## Using the image
### Command line

#### Examples

Run interactively in current directory and compile the current application:

```
docker run -i -t --mount=type=bind,source="$(pwd)",destination=/var/mbed,consistency=delegated -w /var/mbed mbedos/mbed-os-env-cmake

mbed-tools compile -t GCC_ARM -m DISCO_L475VG_IOT01A
```

Build an Mbed OS application directly:

```
docker run -i -t --mount=type=bind,source="$(pwd)",destination=/var/mbed,consistency=delegated -w /var/mbed mbedos/mbed-os-env-cmake mbed-tools compile -t GCC_ARM -m DISCO_L475VG_IOT01A
```

Run GreenTea tests:



### Continuous integration

### Visual Studio Code

## Limitations

### Attaching USB Devices on Mac
Running PyOCD or GreenTea from the Docker