diff options
| author | Ludovic Courtès <ludo@gnu.org> | 2013-07-19 00:07:03 +0200 |
|---|---|---|
| committer | Ludovic Courtès <ludo@gnu.org> | 2013-07-19 00:07:03 +0200 |
| commit | 8b2d9e5d44691110aa34d768d3aae4a4d862011a (patch) | |
| tree | 08cbb11b18cf8f57c94ef83bc5d1f225494d5010 | |
| parent | 3253830d46cc55dd6b946468edd6a6f72944ef48 (diff) | |
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.
| -rw-r--r-- | HACKING | 29 | ||||
| -rw-r--r-- | README | 19 |
2 files changed, 22 insertions, 26 deletions
| @@ -12,14 +12,25 @@ Copyright © 2013 Nikita Karetnikov <nikita@karetnikov.org> | |||
| 12 | 12 | ||
| 13 | * Building from Git | 13 | * Building from Git |
| 14 | 14 | ||
| 15 | First, make sure that Autoconf (>= 2.69), Automake, and pkg-config are | 15 | When building Guix from a checkout, the following packages are required in |
| 16 | installed. Run ‘./bootstrap’ that, among other things, invokes ‘git submodule | 16 | addition to those mentioned in the installation instructions: |
| 17 | update’, or you might get the following error | 17 | |
| 18 | - [[http://www.gnu.org/software/autoconf/][GNU Autoconf]] | ||
| 19 | - [[http://www.gnu.org/software/automake/][GNU Automake]] | ||
| 20 | - [[http://www.gnu.org/software/gettext/][GNU Gettext]] | ||
| 21 | - [[http://www.graphviz.org/][Graphviz]] | ||
| 22 | |||
| 23 | Run ‘./bootstrap’ to download the Nix daemon source code and to generate the | ||
| 24 | build system infrastructure using autoconf. It reports an error if an | ||
| 25 | inappropriate version of the above packages is being used. | ||
| 26 | |||
| 27 | The ‘bootstrap’ script, among other things, invokes ‘git submodule update’; if | ||
| 28 | you didn’t run it, you may get the following error: | ||
| 18 | 29 | ||
| 19 | make: *** No rule to make target `nix/libstore/schema.sql', needed by | 30 | make: *** No rule to make target `nix/libstore/schema.sql', needed by |
| 20 | `nix/libstore/schema.sql.hh' | 31 | `nix/libstore/schema.sql.hh' |
| 21 | 32 | ||
| 22 | Then, as always, run ‘./configure’. If you get an error like this one | 33 | Then, as always, run ‘./configure’. If you get an error like this one: |
| 23 | 34 | ||
| 24 | ./configure: line 6755: `PKG_CHECK_MODULES(GUILE, guile-2.0 >= 2.0.5)' | 35 | ./configure: line 6755: `PKG_CHECK_MODULES(GUILE, guile-2.0 >= 2.0.5)' |
| 25 | 36 | ||
| @@ -32,17 +43,9 @@ installed Automake in ‘/usr/local’, it wouldn’t look for ‘.m4’ files i | |||
| 32 | 43 | ||
| 33 | See “info '(automake) Macro Search Path'” for more information. | 44 | See “info '(automake) Macro Search Path'” for more information. |
| 34 | 45 | ||
| 35 | After that you should proceed with ‘make’. You might also get this error | ||
| 36 | |||
| 37 | /bin/bash: dot: command not found | ||
| 38 | make[2]: *** [doc/images/bootstrap-graph.png] Error 127 | ||
| 39 | |||
| 40 | This one is easy to handle; just install Graphviz. It is not listed as a | ||
| 41 | requirement because the resulting images should come with a tarball. | ||
| 42 | |||
| 43 | Finally, you have to invoke ‘make check’ to run tests. If anything fails, | 46 | Finally, you have to invoke ‘make check’ to run tests. If anything fails, |
| 44 | take a look at “info '(guix) Installation'” or send a message to | 47 | take a look at “info '(guix) Installation'” or send a message to |
| 45 | <bug-guix@gnu.org>. | 48 | <guix-devel@gnu.org>. |
| 46 | 49 | ||
| 47 | * Running Guix before it is installed | 50 | * Running Guix before it is installed |
| 48 | 51 | ||
| @@ -33,23 +33,16 @@ When `--disable-daemon' was passed, you instead need the following: | |||
| 33 | 33 | ||
| 34 | - [[http://nixos.org/nix/][Nix]] | 34 | - [[http://nixos.org/nix/][Nix]] |
| 35 | 35 | ||
| 36 | Optionally, packages from Nixpkgs may be transparently reused from Guix. | 36 | * Installation |
| 37 | For this to work, you need to have a checkout of the Nixpkgs repository; | ||
| 38 | the `--with-nixpkgs' option allows you to let `configure' know where the | ||
| 39 | Nixpkgs checkout is. | ||
| 40 | 37 | ||
| 41 | - [[http://nixos.org/nixpkgs/][Nixpkgs]] | 38 | See the manual for the installation instructions, either by running |
| 42 | 39 | ||
| 43 | When building Guix from a checkout, the following packages are also | 40 | info -f doc/guix.info "(guix) Installation" |
| 44 | required: | ||
| 45 | 41 | ||
| 46 | - [[http://www.gnu.org/software/autoconf/][GNU Autoconf]] | 42 | or by checking the [[http://www.gnu.org/software/guix/manual/guix.html#Installation][web copy of the manual]]. |
| 47 | - [[http://www.gnu.org/software/automake/][GNU Automake]] | ||
| 48 | - [[http://www.gnu.org/software/gettext/][GNU Gettext]] | ||
| 49 | 43 | ||
| 50 | Run the "bootstrap" script to download the Nix daemon and to generate the | 44 | For information on installation from a Git checkout, please see the ‘HACKING’ |
| 51 | build system infrastructure using autoconf. It reports an error if an | 45 | file. |
| 52 | inappropriate version of the above packages is being used. | ||
| 53 | 46 | ||
| 54 | * Installing Guix from Guix | 47 | * Installing Guix from Guix |
| 55 | 48 | ||
