kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-23 05:23:50 +01:00
Code Releases Activity

doc/guides: document DOCKER_IMAGE environment variable

Browse Source
This commit is contained in:
Mikolai Gütschow 2025-11-26 13:41:17 +01:00
parent 2aafabd481
commit ae51b869df
No known key found for this signature in database
GPG Key ID: 943E2F37AA659AD5
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/guides/build-system/build-in-docker.md
View File

@ -17,18 +17,28 @@ If your user does not have permissions to access the Docker daemon:
$ BUILD_IN_DOCKER=1 DOCKER="sudo docker" make $ BUILD_IN_DOCKER=1 DOCKER="sudo docker" make
``` ```
to always use Docker for building, set `BUILD_IN_DOCKER=1` (and if necessary To always use Docker for building, set `BUILD_IN_DOCKER=1` (and if necessary
`DOCKER="sudo docker"`) in the environment: `DOCKER="sudo docker"`) in the environment:
```console ```console
$ export BUILD_IN_DOCKER=1 $ export BUILD_IN_DOCKER=1
``` ```
## Targets ran in Docker: DOCKER_MAKECMDGOALS_POSSIBLE The used Docker image defaults to a pinned version of [riot/riotbuild] for a
given commit in the RIOT repository. It can be overwritten via the environment
variable `DOCKER_IMAGE`, for example:
Currently only build related targets are ran in the docker container, the exact ```shell
$ BUILD_IN_DOCKER=1 DOCKER_IMAGE="local/tinybuild-native64:latest" make
```
## Targets run in Docker: DOCKER_MAKECMDGOALS_POSSIBLE
Currently, only build-related targets are run in the Docker container, the exact
list is under `DOCKER_MAKECMDGOALS_POSSIBLE` variable. list is under `DOCKER_MAKECMDGOALS_POSSIBLE` variable.
For `native` boards, `make test` is also executed within the Docker container.
## Environment Variables: DOCKER_ENV_VARS ## Environment Variables: DOCKER_ENV_VARS
When building in docker one might want for the command ran in docker to inherit When building in docker one might want for the command ran in docker to inherit
@ -130,3 +140,4 @@ evaluated inside the Docker image again), conditional on a less complex environm
variable that gets added to `DOCKER_ENV_VARS` in the Makefile. variable that gets added to `DOCKER_ENV_VARS` in the Makefile.
[option-summary]: https://www.gnu.org/software/make/manual/html_node/Options-Summary.html [option-summary]: https://www.gnu.org/software/make/manual/html_node/Options-Summary.html
[riot/riotbuild]: https://hub.docker.com/r/riot/riotbuild/tags