picnoir/Nix
1
0
Fork 0
Code Issues Pull requests 1 Releases Wiki Activity

reword section on make variables

Browse source 
- use one line per sentence
- use imperative for instructions
- add link to Make documentation
This commit is contained in:
Valentin Gagarin 2024-01-17 04:39:26 +01:00
parent f134dbdffb
commit 28eb406834
1 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -113,11 +113,9 @@ You can also build Nix for one of the [supported platforms](#platforms).
## Makefile variables ## Makefile variables
You may need `profiledir=$out/etc/profile.d` and `sysconfdir=$out/etc` to run You may need `profiledir=$out/etc/profile.d` and `sysconfdir=$out/etc` to run `make install`.
`make install`.
You may want to set `MAKEFLAGS="-e -j $NIX_BUILD_CORES"` to allow environment Run `make` with [`--environment-overrides`](https://www.gnu.org/software/make/manual/make.html#index-_002de) to allow environment variables to override `Makefile` variables:
variables to override `Makefile` variables.
- `ENABLE_BUILD=yes` to enable building the C++ code. - `ENABLE_BUILD=yes` to enable building the C++ code.
- `ENABLE_DOC_GEN=yes` to enable building the documentation (manual, man pages, etc.). - `ENABLE_DOC_GEN=yes` to enable building the documentation (manual, man pages, etc.).
@ -126,11 +124,12 @@ variables to override `Makefile` variables.
- `ENABLE_FUNCTIONAL_TESTS=yes` to enable building the functional tests. - `ENABLE_FUNCTIONAL_TESTS=yes` to enable building the functional tests.
- `ENABLE_UNIT_TESTS=yes` to enable building the unit tests. - `ENABLE_UNIT_TESTS=yes` to enable building the unit tests.
- `OPTIMIZE=1` to enable optimizations. - `OPTIMIZE=1` to enable optimizations.
- `libraries=libutil programs=` to only build a specific library (this will - `libraries=libutil programs=` to only build a specific library.
fail in the linking phase if you don't have the other libraries built, but is
useful for checking types). This will fail in the linking phase if the other libraries haven't been built, but is useful for checking types.
- `libraries= programs=nix` to only build a specific program (this will not, in - `libraries= programs=nix` to only build a specific program.
general, work, because the programs need the libraries).
This will not work in general, because the programs need the libraries.
## Platforms ## Platforms