Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: small fix of "Getting Started" document structure in section docker #17756

Merged
merged 2 commits into from
Mar 7, 2022
Merged

doc: small fix of "Getting Started" document structure in section docker #17756

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1fd11c
doc: fix "Getting Started" structure for section docker
gschorcht Mar 6, 2022
4220f65
doc: remove backticks from headings in "Getting Started"
gschorcht Mar 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions doc/doxygen/src/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,6 +308,8 @@ The user on your computer requires permission to access and use docker. There ar
- Your OS distribution may create a group called `docker`. If so, then adding yourself to that group (and logging out and in again) should grant you permission.
- Execute docker with sudo. This is in fact the most secure and recommended setup (see [here](https://docs.docker.com/install/linux/linux-postinstall/), [here](https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface), [here](https://www.projectatomic.io/blog/2015/08/why-we-dont-let-non-root-users-run-docker-in-centos-fedora-or-rhel/) and [here](https://fosterelli.co/privilege-escalation-via-docker.html)). No extra setup steps are needed. `make` should be instructed to use `sudo` by setting `DOCKER="sudo docker"` in the command line.

### Downloading and testing RIOT docker container

Finally, download the pre-built RIOT Docker container:

```console
Expand All @@ -321,7 +323,8 @@ This will take a while. If it finishes correctly, you can then use the toolchain
$ docker run --rm -i -t -u $UID -v $(pwd):/data/riotbuild riot/riotbuild ./dist/tools/compile_test/compile_test.py
```

# Usage
Usage
-----

The RIOT build system provides support for using the Docker container to build RIOT projects, so you do not need to type the long docker command line every time:

Expand Down Expand Up @@ -350,8 +353,8 @@ Troubleshooting {#docker-troubleshooting}

On some Ubuntu versions a make with `BUILD_IN_DOCKER=1` can't resolve the host name of for example github.com. To fix this add the file `/etc/docker/daemon.json` with the address of your DNS Server.

Generating `compile_commands.json` e.g. for code completion in IDEs
===================================================================
Generating compile_commands.json e.g. for code completion in IDEs
=================================================================

A `compile_commands.json` for the selected board can be generated by running inside the application
folder the following:
Expand Down