Deuxfleurs/garage
36
58
Fork 77
Code Issues 102 Pull requests 17 Releases 30 Wiki Activity

doc: Fix Nix devenv setup
Some checks are pending
ci/woodpecker/push/debug Pipeline is pending
Details
ci/woodpecker/pr/debug Pipeline is pending
Details

Browse source 
This is a hotfix to fix the doc for the current setup, see #868 for
possible future directions.
This commit is contained in:
Baptiste Jonglez 2025-01-16 10:00:09 +01:00
parent 255b01b626
commit 58b9eb46fc
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/book/development/devenv.md
View file

@ -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: 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 ```bash
nix-shell nix-shell -A devShell
``` ```
You can use the traditional Rust development workflow: 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: Our build has multiple parameters you might want to set:
- `release` build with release optimisations instead of debug - `release` to build with release optimisations instead of debug
- `target allows` for cross compilation - `target` allows for cross compilation
- `compileMode` can be set to test or bench to build a unit test runner - `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` - `git_version` to inject the hash to display when running `garage stats`