diff --git a/README.md b/README.md index d590251ec..067a1030f 100644 --- a/README.md +++ b/README.md @@ -121,11 +121,10 @@ the crates which use them: ### Quick start for running the tests in this repository -The only requirements for building and running the tests in this repository are -Linux, Make, [rustup](https://rustup.rs/), and [Nix](https://nix.dev/). This -repository contains scripts for setting up a Docker container with a suitable -development environment in case you aren't on Linux or don't want to install -Nix. +The only requirements for building and running the tests in this repository are Linux, Make, +[rustup](https://rustup.rs/), and [Nix](https://nix.dev/). This repository contains scripts for +setting up a Docker container with a suitable development environment in case you aren't on Linux or +don't want to install Nix. First, clone this repository: @@ -134,16 +133,15 @@ git clone https://github.com/seL4/rust-sel4 cd rust-sel4 ``` -If you are using Docker, build, run, and enter a Docker container for -development. This container mounts this repository's top-level at `/work`. +If you are using Docker, build, run, and enter a Docker container for development. This container +mounts this repository's top-level at `/work`. ``` cd hacking/docker && make run && make exec ``` -At this repository's top-level directory, build and simulate a simple seL4-based -system with a [root task](./crates/examples/root-task/example-root-task) written -in Rust (this will take a few minutes): +At this repository's top-level directory, build and simulate a simple seL4-based system with a [root +task](./crates/examples/root-task/example-root-task) written in Rust (this will take a few minutes): ``` make example diff --git a/hacking/docker/Dockerfile b/hacking/docker/Dockerfile index 55b15c19e..2f90a24f9 100644 --- a/hacking/docker/Dockerfile +++ b/hacking/docker/Dockerfile @@ -32,10 +32,9 @@ RUN set -eux; \ if ! [ $UID = 0 -a $GID = 0 ]; then \ ! getent passwd $UID; \ # NOTE - # This is a bit of a hack. For example, GID for "staff" on MacOS is - # "dialout" on Debian. In an ideal world, we'd ensure that an - # already-occupied GID corresponds to either "users" or "staff" on - # Debian. + # This is a bit of a hack. For example, GID for "staff" on MacOS is "dialout" on Debian. In + # an ideal world, we'd ensure that an already-occupied GID corresponds to either "users" or + # "staff" on Debian. if ! getent group $GID; then \ groupadd -g $GID x; \ fi; \ @@ -71,8 +70,8 @@ RUN set -eux; \ nix-channel --remove nixpkgs; \ nix-collect-garbage -d -# Add gcroot for store paths required by this image so that fresh images can use -# persistent /nix volumes. +# Add gcroot for store paths required by this image so that fresh images can use persistent /nix +# volumes. RUN set -eux; \ export USER=$(whoami); \ . ~/.nix-profile/etc/profile.d/nix.sh; \