Add hacking notes plus a script for running nix-shell

This commit is contained in:
Eelco Dolstra 2013-07-19 16:51:31 +02:00
parent 15e5ac8039
commit 7b09e9f2c4
3 changed files with 54 additions and 0 deletions

12
dev-shell Executable file
View file

@ -0,0 +1,12 @@
#! /bin/sh
s=$(type -p nix-shell)
exec $s release.nix -A tarball --command "
export NIX_REMOTE=daemon
export NIX_PATH='$NIX_PATH'
export NIX_BUILD_SHELL=$(type -p bash)
export c=\$configureFlags
exec $s release.nix -A build.x86_64-linux --exclude tarball --command '
configureFlags+=\" \$c --prefix=$(pwd)/inst --sysconfdir=$(pwd)/inst/etc\"
return
'" \
"$@"

41
doc/manual/hacking.xml Normal file
View file

@ -0,0 +1,41 @@
<appendix xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="chap-hacking">
<title>Hacking</title>
<para>This section provides some notes on how to hack on Nix. To get
the latest version of Nix from GitHub:
<screen>
$ git clone git://github.com/NixOS/nix.git
$ cd hydra
</screen>
</para>
<para>To build it and its dependencies:
<screen>
$ nix-build release.nix -A build.x86_64-linux
</screen>
</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>
$ ./dev-shell
</screen>
To build Nix itself in this shell:
<screen>
[nix-shell]$ ./bootstrap
[nix-shell]$ configurePhase
[nix-shell]$ make
</screen>
To test it:
<screen>
[nix-shell]$ make install
[nix-shell]$ make installcheck
</screen>
</para>
</appendix>

View file

@ -73,6 +73,7 @@
<xi:include href="troubleshooting.xml" /> <xi:include href="troubleshooting.xml" />
<!-- <xi:include href="bugs.xml" /> --> <!-- <xi:include href="bugs.xml" /> -->
<xi:include href="glossary.xml" /> <xi:include href="glossary.xml" />
<xi:include href="hacking.xml" />
<appendix> <appendix>
<title>Nix Release Notes</title> <title>Nix Release Notes</title>