diff options
| author | Baptiste Jonglez <baptiste.jonglez@inria.fr> | 2025-01-16 10:00:09 +0100 |
|---|---|---|
| committer | Baptiste Jonglez <baptiste.jonglez@inria.fr> | 2025-01-16 10:00:12 +0100 |
| commit | 58b9eb46fcb7f58b32ee3342b4fd5957d1eb8044 (patch) | |
| tree | 6ff947ee3243d77f043783b28ab94aa52bc07344 | |
| parent | 255b01b626096ef98cf24c9552b39c0372fb4eb3 (diff) | |
| download | garage-fix_devenv.tar.gz garage-fix_devenv.zip | |
doc: Fix Nix devenv setupfix_devenv
This is a hotfix to fix the doc for the current setup, see #868 for
possible future directions.
| -rw-r--r-- | doc/book/development/devenv.md | 6 |
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` |