Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document Makefile variables in hacking.md #9620

Merged
merged 2 commits into from
Dec 16, 2023
Merged

Document Makefile variables in hacking.md #9620

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f14cf7a
Document `Makefile` variables in `hacking.md`
9999years Dec 16, 2023
72b6314
fix linebreak
fricklerhandwerk Dec 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/manual/src/contributing/hacking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,15 @@ $ nix build

You can also build Nix for one of the [supported platforms](#platforms).

## Makefile variables

- `ENABLE_BUILD=yes` to enable building the C++ code.
- `ENABLE_TESTS=yes` to enable building the tests.
- `OPTIMIZE=1` to enable optimizations.
- `doc_generate=yes` to enable building the documentation (manual, man pages, etc.).

The docs can take a while to build, so you may want to disable this for local development.

## Building Nix

To build all dependencies and start a shell in which all environment variables are set up so that those dependencies can be found:
Expand Down