aboutsummaryrefslogtreecommitdiff
path: root/doc/book
diff options
context:
space:
mode:
authorAlex <lx@deuxfleurs.fr>2025-01-23 10:20:04 +0000
committerAlex <lx@deuxfleurs.fr>2025-01-23 10:20:04 +0000
commit591bd808ec7f04973340c609a1f5251a642d1600 (patch)
treec7ada103527107f39f7e4026d3d841fcd8829035 /doc/book
parent294cb9940943d7febc1029ed44145daf57f914d0 (diff)
parent58b9eb46fcb7f58b32ee3342b4fd5957d1eb8044 (diff)
downloadgarage-591bd808ec7f04973340c609a1f5251a642d1600.tar.gz
garage-591bd808ec7f04973340c609a1f5251a642d1600.zip
Merge pull request 'doc: Fix Nix devenv setup' (#927) from fix_devenv into main
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/927
Diffstat (limited to 'doc/book')
-rw-r--r--doc/book/development/devenv.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/book/development/devenv.md b/doc/book/development/devenv.md
index 88f8ba06..518fd232 100644
--- a/doc/book/development/devenv.md
+++ b/doc/book/development/devenv.md
@@ -36,7 +36,7 @@ sudo killall nix-daemon
Now you can enter our nix-shell, all the required packages will be downloaded but they will not pollute your environment outside of the shell:
```bash
-nix-shell
+nix-shell -A devShell
```
You can use the traditional Rust development workflow:
@@ -65,8 +65,8 @@ nix-build -j $(nproc) --max-jobs auto
```
Our build has multiple parameters you might want to set:
- - `release` build with release optimisations instead of debug
- - `target allows` for cross compilation
+ - `release` to build with release optimisations instead of debug
+ - `target` allows for cross compilation
- `compileMode` can be set to test or bench to build a unit test runner
- `git_version` to inject the hash to display when running `garage stats`