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

Merge pull request #8556 from fricklerhandwerk/hacking-headings

Browse source 
hacking guide: use more self-descriptive section headings
This commit is contained in:
Valentin Gagarin 2023-06-22 13:45:31 +02:00 committed by GitHub
parent 48fe0ed554 5f9a921bc1
commit 0ab962d83f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/manual/redirects.js
View file

@ -344,6 +344,10 @@ const redirects = {
"macos": "uninstall.html#macos", "macos": "uninstall.html#macos",
"uninstalling": "uninstall.html" "uninstalling": "uninstall.html"
} }
"contributing/hacking.html": {
"nix-with-flakes": "#building-nix-with-flakes"
"classic-nix": "#building-nix"
}
}; };
// the following code matches the current page's URL against the set of redirects. // the following code matches the current page's URL against the set of redirects.

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

@ -12,14 +12,15 @@ The following instructions assume you already have some version of Nix installed
[installation instructions]: ../installation/installation.md [installation instructions]: ../installation/installation.md
## Nix with flakes ## Building Nix with flakes
This section assumes you are using Nix with [flakes] enabled. See the [next section](#classic-nix) for equivalent instructions which don't require flakes. This section assumes you are using Nix with the [`flakes`] and [`nix-command`] experimental features enabled.
See the [Building Nix](#building-nix) section for equivalent instructions using stable Nix interfaces.
[flakes]: ../command-ref/new-cli/nix3-flake.md#description [`flakes`]: @docroot@/contributing/experimental-features.md#xp-feature-flakes
[`nix-command`]: @docroot@/contributing/experimental-features.md#xp-nix-command
To build all dependencies and start a shell in which all environment To build all dependencies and start a shell in which all environment variables are set up so that those dependencies can be found:
variables are set up so that those dependencies can be found:
```console ```console
$ nix develop $ nix develop
@ -55,20 +56,17 @@ To install it in `$(pwd)/outputs` and test it:
nix (Nix) 2.12 nix (Nix) 2.12
``` ```
To build a release version of Nix: To build a release version of Nix for the current operating system and CPU architecture:
```console ```console
$ nix build $ nix build
``` ```
You can also build Nix for one of the [supported target platforms](#target-platforms). You can also build Nix for one of the [supported platforms](#platforms).
## Classic Nix ## Building Nix
This section is for Nix without [flakes]. To build all dependencies and start a shell in which all environment variables are set up so that those dependencies can be found:
To build all dependencies and start a shell in which all environment
variables are set up so that those dependencies can be found:
```console ```console
$ nix-shell $ nix-shell
@ -102,13 +100,13 @@ To install it in `$(pwd)/outputs` and test it:
nix (Nix) 2.12 nix (Nix) 2.12
``` ```
To build Nix for the current operating system and CPU architecture use To build a release version of Nix for the current operating system and CPU architecture:
```console ```console
$ nix-build $ nix-build
``` ```
You can also build Nix for one of the [supported target platforms](#target-platforms). You can also build Nix for one of the [supported platforms](#platforms).
## Platforms ## Platforms