aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/hacking.md
blob: f8375822de7be6bf641184a3bbd8095f67dca707 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# Hacking

This section provides some notes on how to hack on Nix. To get the
latest version of Nix from GitHub:

    $ git clone https://github.com/NixOS/nix.git
    $ cd nix

To build Nix for the current operating system/architecture use

    $ nix-build

or if you have a flakes-enabled nix:

    $ nix build

This will build `defaultPackage` attribute defined in the `flake.nix`
file. To build for other platforms add one of the following suffixes to
it: aarch64-linux, i686-linux, x86\_64-darwin, x86\_64-linux. i.e.

    $ nix-build -A defaultPackage.x86_64-linux

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

    $ nix-shell

To build Nix itself in this shell:

    [nix-shell]$ ./bootstrap.sh
    [nix-shell]$ ./configure $configureFlags
    [nix-shell]$ make -j $NIX_BUILD_CORES

To install it in `$(pwd)/inst` and test it:

    [nix-shell]$ make install
    [nix-shell]$ make installcheck
    [nix-shell]$ ./inst/bin/nix --version
    nix (Nix) 2.4

If you have a flakes-enabled nix you can replace:

    $ nix-shell

by:

    $ nix develop