RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

makefiles:docker.inc.mk: add a global documentation on directory mapping

Browse Source
This commit is contained in:
cladmi 2018-10-18 01:27:43 +02:00 committed by Gaëtan Harter
parent 3c0ecebb2c
commit 8b54f87fc4
No known key found for this signature in database
GPG Key ID: 76DF6BCF1B1F883B
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
makefiles/docker.inc.mk
View File

@ -93,6 +93,28 @@ ETC_LOCALTIME = $(realpath /etc/localtime)
# # # # # # # # # # # # # # # #
# Directory mapping functions #
# # # # # # # # # # # # # # # #
#
# This part handles mapping and mounting directories variables from the
# host system in the docker container.
#
# In the container all directories are mapped in subdirectories of
# `DOCKER_BUILD_ROOT` (`/data/riotbuild` by default).
#
#
# The RIOT directory `RIOTBASE` is mounted to `DOCKER_RIOTBASE`
# (`DOCKER_BUILD_ROOT/riotbase` by default).
#
# For other directories variables:
#
# * if the directory is contained within the `RIOT` repository,
# the variable is mapped to a path inside `DOCKER_RIOTBASE` in the container.
#
# * if the directory is not contained in the `RIOT` repository,
# the directory must be mounted in the countainer.
# The variable and directory are mapped to a path outside `DOCKER_RIOTBASE`.
# Some variables have hardwritten mapping directories (`RIOTCPU` for example),
# and other have a mapping directory based on their directory name.
# Test if a directory is a subdirectory of `RIOTBASE`
#