Skip to content

Commit

Permalink
Improve comment wrap width consistency
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Spinale <[email protected]>
  • Loading branch information
nspin committed Dec 28, 2023
1 parent 1caa271 commit d6d8bd5
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 16 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
Expand Down
11 changes: 5 additions & 6 deletions hacking/docker/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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; \
Expand Down Expand Up @@ -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; \
Expand Down

0 comments on commit d6d8bd5

Please sign in to comment.