doc: Improve build instructions in README and HACKING.
* README (Requirements): Remove Nixpkgs. Remove mentions of building from Git. (Installation): Refer to the manual. * HACKING: List requirements for when building from Git. Remove the `dot: Command not found' error.
This commit is contained in:
parent
3253830d46
commit
8b2d9e5d44
29
HACKING
29
HACKING
@ -12,14 +12,25 @@ Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org>
|
|||||||
|
|
||||||
* Building from Git
|
* Building from Git
|
||||||
|
|
||||||
First, make sure that Autoconf (>= 2.69), Automake, and pkg-config are
|
When building Guix from a checkout, the following packages are required in
|
||||||
installed. Run ‘./bootstrap’ that, among other things, invokes ‘git submodule
|
addition to those mentioned in the installation instructions:
|
||||||
update’, or you might get the following error
|
|
||||||
|
- [[http://www.gnu.org/software/autoconf/][GNU Autoconf]]
|
||||||
|
- [[http://www.gnu.org/software/automake/][GNU Automake]]
|
||||||
|
- [[http://www.gnu.org/software/gettext/][GNU Gettext]]
|
||||||
|
- [[http://www.graphviz.org/][Graphviz]]
|
||||||
|
|
||||||
|
Run ‘./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 ‘bootstrap’ script, among other things, invokes ‘git submodule update’; if
|
||||||
|
you didn’t run it, you may get the following error:
|
||||||
|
|
||||||
make: *** No rule to make target `nix/libstore/schema.sql', needed by
|
make: *** No rule to make target `nix/libstore/schema.sql', needed by
|
||||||
`nix/libstore/schema.sql.hh'
|
`nix/libstore/schema.sql.hh'
|
||||||
|
|
||||||
Then, as always, run ‘./configure’. If you get an error like this one
|
Then, as always, run ‘./configure’. If you get an error like this one:
|
||||||
|
|
||||||
./configure: line 6755: `PKG_CHECK_MODULES(GUILE, guile-2.0 >= 2.0.5)'
|
./configure: line 6755: `PKG_CHECK_MODULES(GUILE, guile-2.0 >= 2.0.5)'
|
||||||
|
|
||||||
@ -32,17 +43,9 @@ installed Automake in ‘/usr/local’, it wouldn’t look for ‘.m4’ files i
|
|||||||
|
|
||||||
See “info '(automake) Macro Search Path'” for more information.
|
See “info '(automake) Macro Search Path'” for more information.
|
||||||
|
|
||||||
After that you should proceed with ‘make’. You might also get this error
|
|
||||||
|
|
||||||
/bin/bash: dot: command not found
|
|
||||||
make[2]: *** [doc/images/bootstrap-graph.png] Error 127
|
|
||||||
|
|
||||||
This one is easy to handle; just install Graphviz. It is not listed as a
|
|
||||||
requirement because the resulting images should come with a tarball.
|
|
||||||
|
|
||||||
Finally, you have to invoke ‘make check’ to run tests. If anything fails,
|
Finally, you have to invoke ‘make check’ to run tests. If anything fails,
|
||||||
take a look at “info '(guix) Installation'” or send a message to
|
take a look at “info '(guix) Installation'” or send a message to
|
||||||
<bug-guix@gnu.org>.
|
<guix-devel@gnu.org>.
|
||||||
|
|
||||||
* Running Guix before it is installed
|
* Running Guix before it is installed
|
||||||
|
|
||||||
|
19
README
19
README
@ -33,23 +33,16 @@ When `--disable-daemon' was passed, you instead need the following:
|
|||||||
|
|
||||||
- [[http://nixos.org/nix/][Nix]]
|
- [[http://nixos.org/nix/][Nix]]
|
||||||
|
|
||||||
Optionally, packages from Nixpkgs may be transparently reused from Guix.
|
* Installation
|
||||||
For this to work, you need to have a checkout of the Nixpkgs repository;
|
|
||||||
the `--with-nixpkgs' option allows you to let `configure' know where the
|
|
||||||
Nixpkgs checkout is.
|
|
||||||
|
|
||||||
- [[http://nixos.org/nixpkgs/][Nixpkgs]]
|
See the manual for the installation instructions, either by running
|
||||||
|
|
||||||
When building Guix from a checkout, the following packages are also
|
info -f doc/guix.info "(guix) Installation"
|
||||||
required:
|
|
||||||
|
|
||||||
- [[http://www.gnu.org/software/autoconf/][GNU Autoconf]]
|
or by checking the [[http://www.gnu.org/software/guix/manual/guix.html#Installation][web copy of the manual]].
|
||||||
- [[http://www.gnu.org/software/automake/][GNU Automake]]
|
|
||||||
- [[http://www.gnu.org/software/gettext/][GNU Gettext]]
|
|
||||||
|
|
||||||
Run the "bootstrap" script to download the Nix daemon and to generate the
|
For information on installation from a Git checkout, please see the ‘HACKING’
|
||||||
build system infrastructure using autoconf. It reports an error if an
|
file.
|
||||||
inappropriate version of the above packages is being used.
|
|
||||||
|
|
||||||
* Installing Guix from Guix
|
* Installing Guix from Guix
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user