summaryrefslogtreecommitdiff
path: root/doc/contributing.texi
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2015-11-22 11:24:18 +0100
committerLudovic Courtès <ludo@gnu.org>2015-11-22 14:14:25 +0100
commit5fb95cc5925cab6f1105158d6092d8051b58a23e (patch)
tree79d2a98b9195d3fbfd3d59e249fb911e33c55f72 /doc/contributing.texi
parent82e64fc14eec9f01f5fee12782046496ebed9c72 (diff)
downloadpatches-5fb95cc5925cab6f1105158d6092d8051b58a23e.tar
patches-5fb95cc5925cab6f1105158d6092d8051b58a23e.tar.gz
doc: Mention 'guix environment guix'.
* doc/contributing.texi (Building from Git): Mention 'guix environment guix'. Remove outdated description of ./bootstrap. Clarify a few things.
Diffstat (limited to 'doc/contributing.texi')
-rw-r--r--doc/contributing.texi33
1 files changed, 23 insertions, 10 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 996bae3909..a66f5374b9 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -32,23 +32,36 @@ the installation instructions (@pxref{Requirements}).
@item @url{http://www.gnu.org/software/help2man/, GNU Help2man (optional)}.
@end itemize
-Run @command{./bootstrap} to download the Nix daemon source code and to
-generate the build system infrastructure using autoconf. It reports an
-error if an inappropriate version of the above packages is being used.
+The easiest way to set up a development environment for Guix is, of
+course, by using Guix! The following command starts a new shell where
+all the dependencies and appropriate environment variables are set up to
+hack on Guix:
-@noindent
-If you get an error like this one:
+@example
+guix environment guix
+@end example
+
+@xref{Invoking guix environment}, for more information on that command.
+Extra dependencies can be added with @option{--ad-hoc}:
+
+@example
+guix environment guix --ad-hoc help2man git strace
+@end example
+
+Run @command{./bootstrap} to generate the build system infrastructure
+using Autoconf and Automake. If you get an error like this one:
@example
configure.ac:46: error: possibly undefined macro: PKG_CHECK_MODULES
@end example
+@noindent
it probably means that Autoconf couldn’t find @file{pkg.m4}, which is
-provided by @command{pkg-config}. Make sure that @file{pkg.m4} is
-available. For instance, if you installed Automake in
-@file{/usr/local}, it wouldn’t look for @file{.m4} files in
-@file{/usr/share}. So you have to invoke the following command in that
-case
+provided by pkg-config. Make sure that @file{pkg.m4} is available. The
+same holds for the @file{guile.m4} set of macros provided by Guile. For
+instance, if you installed Automake in @file{/usr/local}, it wouldn’t
+look for @file{.m4} files in @file{/usr/share}. In that case, you have
+to invoke the following command:
@example
export ACLOCAL_PATH=/usr/share/aclocal