From 7b09e9f2c49aba7ced0e7fbac3994f6686b6a303 Mon Sep 17 00:00:00 2001
From: Eelco Dolstra <eelco.dolstra@logicblox.com>
Date: Fri, 19 Jul 2013 16:51:31 +0200
Subject: Add hacking notes plus a script for running nix-shell

---
 doc/manual/hacking.xml | 41 +++++++++++++++++++++++++++++++++++++++++
 doc/manual/manual.xml  |  1 +
 2 files changed, 42 insertions(+)
 create mode 100644 doc/manual/hacking.xml

(limited to 'doc')

diff --git a/doc/manual/hacking.xml b/doc/manual/hacking.xml
new file mode 100644
index 000000000000..f8478c9093e6
--- /dev/null
+++ b/doc/manual/hacking.xml
@@ -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>
diff --git a/doc/manual/manual.xml b/doc/manual/manual.xml
index 6abff02d9ef4..671ca9d65c1a 100644
--- a/doc/manual/manual.xml
+++ b/doc/manual/manual.xml
@@ -73,6 +73,7 @@
   <xi:include href="troubleshooting.xml" />
   <!-- <xi:include href="bugs.xml" /> -->
   <xi:include href="glossary.xml" />
+  <xi:include href="hacking.xml" />
 
   <appendix>
     <title>Nix Release Notes</title>
-- 
cgit 1.4.1