diff --git a/README.adoc b/README.adoc index 70661e9..cc8ef3d 100644 --- a/README.adoc +++ b/README.adoc @@ -389,12 +389,17 @@ Workaround by checking out kernel 4.17 as explained at <> [[docker]] -=== QEMU Buildroot setup inside Docker +=== Docker host setup -This is the same as the native <>, but run from inside a link:https://en.wikipedia.org/wiki/Docker_(software)[Docker] on the host. +This repository has been tested inside clean link:https://en.wikipedia.org/wiki/Docker_(software)[Docker] containers. This is a good option if you are on a Linux host, but the native setup failed due to your weird host distribution, and you have better things to do with your life than to debug it. +Buildroot is the most complex thing we build, and therefore the most likely to break, so running inside Docker is specially relevant to run: + +* <> +* <> + Before anything, you must get rid of any host build files on `out/` if you have any. A simple way to do this it to: .... @@ -439,15 +444,15 @@ Restart the container: ./rundocker .... -Open a second shell in a running container: +In order to use functionality such as <>, you need a second shell inside the container. You can either do that with: .... ./rundocker sh .... -You will need this for example to use <>. +or even better, by starting a <> session inside the container. We install `tmux` by default in the container. -Start a second shell, and run a command in it at the same time: +You can start a second shell and run a command in it at the same time with: .... ./rundocker sh ./rungdb start_kernel @@ -495,12 +500,14 @@ After this, to start using Docker again will you need another: ./rundocker setup .... +Tested on: a760cb1196161e913a94684e03cfeaebf71f0cdd + [[prebuilt]] === Prebuilt setup ==== About the prebuilt setup -This setup uses prebuilt binaries of the <> that we upload to GitHub from time to time. +This setup uses prebuilt binaries of the <> that we upload to GitHub from time to time. We don't currently provide a full prebuilt because it would be too big to host freely, notably because of the cross toolchain.