Skip to content

Commit cc7163d

Browse files
committed
readme: make host docker awesome
1 parent a760cb1 commit cc7163d

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.adoc

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -389,12 +389,17 @@ Workaround by checking out kernel 4.17 as explained at <<linux-kernel-build-vari
389389
More information at: <<gem5>>
390390

391391
[[docker]]
392-
=== QEMU Buildroot setup inside Docker
392+
=== Docker host setup
393393

394-
This is the same as the native <<qemu-buildroot-setup>>, but run from inside a link:https://en.wikipedia.org/wiki/Docker_(software)[Docker] on the host.
394+
This repository has been tested inside clean link:https://en.wikipedia.org/wiki/Docker_(software)[Docker] containers.
395395

396396
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.
397397

398+
Buildroot is the most complex thing we build, and therefore the most likely to break, so running inside Docker is specially relevant to run:
399+
400+
* <<qemu-buildroot-setup>>
401+
* <<gem5-buildroot-setup>>
402+
398403
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:
399404

400405
....
@@ -439,15 +444,15 @@ Restart the container:
439444
./rundocker
440445
....
441446

442-
Open a second shell in a running container:
447+
In order to use functionality such as <<gdb>>, you need a second shell inside the container. You can either do that with:
443448

444449
....
445450
./rundocker sh
446451
....
447452

448-
You will need this for example to use <<gdb>>.
453+
or even better, by starting a <<tmux>> session inside the container. We install `tmux` by default in the container.
449454

450-
Start a second shell, and run a command in it at the same time:
455+
You can start a second shell and run a command in it at the same time with:
451456

452457
....
453458
./rundocker sh ./rungdb start_kernel
@@ -495,12 +500,14 @@ After this, to start using Docker again will you need another:
495500
./rundocker setup
496501
....
497502

503+
Tested on: a760cb1196161e913a94684e03cfeaebf71f0cdd
504+
498505
[[prebuilt]]
499506
=== Prebuilt setup
500507

501508
==== About the prebuilt setup
502509

503-
This setup uses prebuilt binaries of the <<qemu-buildroot-setup>> that we upload to GitHub from time to time.
510+
This setup uses prebuilt binaries of the <<qemu-buildroot-setup>> that we upload to GitHub from time to time.
504511

505512
We don't currently provide a full prebuilt because it would be too big to host freely, notably because of the cross toolchain.
506513

0 commit comments

Comments
 (0)