diff options
Diffstat (limited to 'doc/buildWithDocker.md')
| -rw-r--r-- | doc/buildWithDocker.md | 85 |
1 files changed, 37 insertions, 48 deletions
diff --git a/doc/buildWithDocker.md b/doc/buildWithDocker.md index 1db5e7a7..771dd774 100644 --- a/doc/buildWithDocker.md +++ b/doc/buildWithDocker.md @@ -1,69 +1,58 @@ # Build the project using Docker There are [Docker images (Dockerfile)](../docker) containing the build environment for AMD64 (x86_64) and ARM64 architectures. These images make the build of the firmware and the generation of the DFU file for OTA quite easy, as well as preventing clashes with any other toolchains or development environments you may have installed. -## Using the image from Docker Hub +Based on Ubuntu 18.04 with the following build dependencies: -The image is avaiable via Docker Hub for both the amd64 and arm64v8 architectures at [pfeerick/infinitime-build](https://hub.docker.com/repository/docker/pfeerick/infinitime-build). - -It can be pulled (downloaded) using the following command: - -``` -docker pull pfeerick/infinitime-build -``` - -The default `latest` tag *should* automatically identify the correct image architecture, but if for some reason Docker does not, you can specify it manually: - -* For AMD64 (x86_64) systems: `docker pull pfeerick/infinitime-build:amd64` - -* For ARM64v8 (ARM64/aarch64) systems: `docker pull pfeerick/infinitime-build:arm64v8` +When this is done, a new image named *infinitime-build* is available. +* ARM GCC Toolchain +* nRF SDK +* MCUBoot +* adafruit-nrfutil -The Docker Hub images are built using 1000:1000 for the user id and group id. If this is different to your user or group ids (run `id -u` and `id -g` to find out what your id values are if you are unsure), you will need to override them via the `--user` parameter in order to prevent permission errors during and after compilation. +## Run a container to build the project: +The `infinitime-build` image contains all the dependencies you need. The default `CMD` will compile sources found in `/sources`, so you need only mount your code. -The below example will run the container, setting the user and group ids automatically: +This example will build the firmware, generate the MCUBoot image and generate the DFU file. Outputs will be written to **<project_root>/build/output**: -``` -docker run --rm -v <project_root>:/sources --user $(id -u):$(id -g) pfeerick/infinitime-build +```bash +$ cd <project_root> # e.g. cd ./work/Pinetime +$ docker run --rm -it -v $(pwd):/sources infinitime-build ``` -Or you can specify your user id and group id (by number, not by name) directly: - -``` -docker run --rm -v <project_root>:/sources --user uid_num:gid_num pfeerick/infinitime-build -``` +* `--rm` to delete the container after we're done. Build cache will be written out to host disk, so no worries. +* `-it` for better interactivity with the running container. + * `-i` Interactive - required if you want to send CTRL+C + * `-t` TTY - This lets colours work nicely etc? +* `-v` for mounting a volume to the container -## Build the image yourself -Building the docker images yourself is quite easy. The following commands must be run from the root of the project. +Output files (and the cmake build cache) will have `uid`/`gid` not matching your host user. To override them, use `docker run` like this: -The `PUID` and `PGID` build arguments are used to set the user and group ids used in the container, meaning you will not need to specify it later unless they change for some reason. Specifying them is not mandatory, as this can be over-ridden at build time via the `--user` flag, but doing so will make the command you need to run later a bit shorter. In the below examples, they are set to your current user id and group id automatically. You can specify them manually, but they must be specified by number, not by name. - -If you are running on a AMD64 (x86_64) computer: -``` -docker image build -t infinitime-build --build-arg PUID=$(id -u) --build-arg PGID=$(id -g) docker/amd64/ -``` - -If you are running on an ARM64 computer (tested on Raspberry Pi 4 and Pine64 Pinebook Pro): -``` -docker image build -t infinitime-build --build-arg PUID=$(id -u) --build-arg PGID=$(id -g) docker/arm64v8/ +```bash +$ docker run --rm -it -v $(pwd):/sources \ + -e USER_ID=$(id -u) -e GROUP_ID=$(id -g) \ + infinitime-build ``` -This operation will take some time, as it builds a Docker image based on Ubuntu, installs some required packages, downloads the ARM toolchain, the NRF SDK, MCUBoot and adafruit-nrfutil. - -When this is done, a new image named *infinitime-build* is available. +If you only want to build a single CMake target, you can pass it in as the first parameter to the build script. This means calling the script explicitly as it will override the `CMD`. Here's an example For `pinetime-app`: -## Run a container to build the project: +```bash +$ docker run --rm -it -v $(pwd):/sources infinitime-build /opt/build.sh pinetime-app +``` -The command to run the container is essentially the same, regardless of whether you built it yourself from the dockerfiles, or are using the Docker Hub images (use `pfeerick/infinitime-build` instead of `infinitime-build` for the later): +## Build the image +The image is not (yet) available on DockerHub, you need to build it yourself, but that is quite easy. The following commands must be run from the root of the project. This operation will take some time but, when done, a new image named *infinitime-build* is available. -``` -docker run --rm -v <project_root>:/sources infinitime-build +```bash +$ docker image build -t infinitime-build ./docker ``` -This will start a container (removing it when finished), build the firmware and generate the MCUBoot image and DFU file. The output of the build is stored in `<project_root>/built/output`. +The resulting -Replace *<project_root>* by the path of the root of the project on your computer. For example: +You can bake your custom USER_ID and GROUP_ID numbers in to the image, then you don't have to pass them to `docker run` every time. +```bash +docker image build -t infinitime-build \ + --build-arg USER_ID=$(id -u) \ + --build-arg GROUP_ID=$(id -g) \ + ./docker ``` -docker run --rm -v /home/jf/git/PineTime:/sources infinitime-build -``` - -If you encounter permission errors (due to being logged in as a different user, changed user id, running the docker hub image, etc.), see the `--user` parameter mentioned above in the Docker Hub image section to see if this resolves the issue for you. |