lix/doc/manual/hacking.xml

75 lines
1.5 KiB
XML
Raw Normal View History

<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-hacking">
<title>Hacking</title>
2020-07-18 07:48:13 +00:00
<para>This section provides some notes on how to hack on Nix. To get
the latest version of Nix from GitHub:
<screen>
2020-07-18 07:48:13 +00:00
$ git clone https://github.com/NixOS/nix.git
2014-02-28 13:01:26 +00:00
$ cd nix
</screen>
</para>
<para>To build Nix for the current operating system/architecture use
2020-07-18 07:48:13 +00:00
<screen>
$ nix-build
</screen>
or if you have a flakes-enabled nix:
<screen>
$ nix build
</screen>
This will build <literal>defaultPackage</literal> attribute defined in the <literal>flake.nix</literal> 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.
<screen>
2020-07-18 07:48:13 +00:00
nix-build -A defaultPackage.x86_64-linux
</screen>
2020-07-18 07:48:13 +00:00
</para>
<para>To build all dependencies and start a shell in which all
environment variables are set up so that those dependencies can be
found:
<screen>
2016-11-28 15:13:23 +00:00
$ nix-shell
</screen>
To build Nix itself in this shell:
<screen>
2014-07-16 09:09:01 +00:00
[nix-shell]$ ./bootstrap.sh
2020-07-18 07:48:13 +00:00
[nix-shell]$ ./configure $configureFlags
[nix-shell]$ make -j $NIX_BUILD_CORES
</screen>
To install it in <literal>$(pwd)/inst</literal> and test it:
<screen>
[nix-shell]$ make install
[nix-shell]$ make installcheck
2020-07-18 07:48:13 +00:00
[nix-shell]$ ./inst/bin/nix --version
nix (Nix) 2.4
</screen>
If you have a flakes-enabled nix you can replace:
<screen>
$ nix-shell
</screen>
by:
<screen>
$ nix develop
</screen>
</para>
</appendix>