lix-project/lix
20
57
Fork 31
Code Issues 347 Code Review (Gerrit) Projects 3 Releases Wiki Activity

Merge "Fix build instructions in hacking.md and justfile" into main

Browse source
This commit is contained in:
Delan Azabani 2024-06-24 06:46:08 +00:00 committed by Gerrit Code Review
parent 37f276ba9d 5d33e4cd59
commit 4c3d93611f
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/manual/src/contributing/hacking.md
View file

@ -39,17 +39,19 @@ $ nix-shell -A native-clangStdenvPackages
### Building from the development shell ### Building from the development shell
As always you may run [stdenv's phases by name](https://nixos.org/manual/nixpkgs/unstable/#sec-building-stdenv-package-in-nix-shell), e.g.: You can build and test Lix with just:
```bash ```bash
$ configurePhase $ just setup
$ buildPhase $ just build
$ checkPhase $ just test --suite=check
$ installPhase $ just install
$ installCheckPhase $ just test --suite=installcheck
``` ```
To build manually, however, use the following: (Check and installcheck may both be done after install, allowing you to omit the --suite argument entirely, but this is the order package.nix runs them in.)
You can also build Lix manually:
```bash ```bash
$ meson setup ./build "--prefix=$out" $mesonFlags $ meson setup ./build "--prefix=$out" $mesonFlags
@ -64,9 +66,7 @@ $ meson install -C build
$ meson test -C build --suite=installcheck $ meson test -C build --suite=installcheck
``` ```
(Check and installcheck may both be done after install, allowing you to omit the --suite argument entirely, but this is the order package.nix runs them in.) In both cases, Lix will be installed to `$PWD/outputs`, the `/bin` of which is prepended to PATH in the development shells.
This will install Lix to `$PWD/outputs`, the `/bin` of which is prepended to PATH in the development shells.
If the tests fail and Meson helpfully has no output for why, use the `--print-error-logs` option to `meson test`. If the tests fail and Meson helpfully has no output for why, use the `--print-error-logs` option to `meson test`.

2
justfile
View file

@ -10,7 +10,7 @@ clean:
# Prepare meson for building # Prepare meson for building
setup: setup:
meson setup build --prefix="$PWD/outputs/out" meson setup build --prefix="$PWD/outputs/out" $mesonFlags
# Build lix # Build lix
build *OPTIONS: build *OPTIONS: