c80e7e55b3
* README: Mention pronunciation of "Guix". * doc/guix.texi (Introduction): Likewise.
112 lines
4.8 KiB
Org Mode
112 lines
4.8 KiB
Org Mode
-*- mode: org -*-
|
||
|
||
[[http://www.gnu.org/software/guix/][GNU Guix]] (IPA: /ɡiːks/) is a purely functional package manager, and
|
||
associated free software distribution, for the [[http://www.gnu.org/gnu/gnu.html][GNU system]]. In addition
|
||
to standard package management features, Guix supports transactional
|
||
upgrades and roll-backs, unprivileged package management, per-user
|
||
profiles, and garbage collection.
|
||
|
||
It provides [[http://www.gnu.org/software/guile/][Guile]] Scheme APIs, including a high-level embedded
|
||
domain-specific languages (EDSLs) to describe how packages are to be
|
||
built and composed.
|
||
|
||
A user-land free software distribution for GNU/Linux comes as part of
|
||
Guix.
|
||
|
||
Guix is based on the [[http://nixos.org/nix/][Nix]] package manager.
|
||
|
||
|
||
* Hacking
|
||
|
||
GNU Guix currently depends on the following packages:
|
||
|
||
- [[http://gnu.org/software/guile/][GNU Guile 2.0.x]]
|
||
- [[http://nixos.org/nix/][Nix]]
|
||
- [[http://gnupg.org/][GNU libgcrypt]]
|
||
|
||
Optionally, packages from Nixpkgs may be transparently reused from Guix.
|
||
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]]
|
||
|
||
When building Guix from a checkout, the following packages are also
|
||
required:
|
||
|
||
- [[http://www.gnu.org/software/autoconf/][GNU Autoconf]]
|
||
- [[http://www.gnu.org/software/automake/][GNU Automake]]
|
||
- [[http://www.gnu.org/software/gettext/][GNU Gettext]]
|
||
|
||
The "autoreconf -vi" command can be used to generate the build system
|
||
infrastructure; it reports an error if an inappropriate version of the
|
||
above packages is being used.
|
||
|
||
* How It Works
|
||
|
||
Guix does the high-level preparation of a /derivation/. A derivation is
|
||
the promise of a build; it is stored as a text file under
|
||
=/nix/store/xxx.drv=. The (guix derivations) module provides the
|
||
`derivation' primitive, as well as higher-level wrappers such as
|
||
`build-expression->derivation'.
|
||
|
||
Guix does remote procedure calls (RPCs) to the Nix daemon (the
|
||
=nix-worker --daemon= command), which in turn performs builds and
|
||
accesses to the Nix store on its behalf. The RPCs are implemented in
|
||
the (guix store) module.
|
||
|
||
* Contact
|
||
|
||
GNU Guix is hosted at https://savannah.gnu.org/projects/guix/.
|
||
|
||
Please email <bug-guix@gnu.org> for bug reports or questions regarding
|
||
Guix and its distribution; email <gnu-system-discuss@gnu.org> for
|
||
general issues regarding the GNU system.
|
||
|
||
Join #guix on irc.freenode.net.
|
||
|
||
* Guix & Nix
|
||
|
||
GNU Guix is based on [[http://nixos.org/nix/][the Nix package manager]]. It implements the same
|
||
package deployment paradigm, and in fact it reuses some of its code.
|
||
Yet, different engineering decisions were made for Guix, as described
|
||
below.
|
||
|
||
Nix is really two things: a package build tool, implemented by a library
|
||
and daemon, and a special-purpose programming language. GNU Guix relies
|
||
on the former, but uses Scheme as a replacement for the latter.
|
||
|
||
Using Scheme instead of a specific language allows us to get all the
|
||
features and tooling that come with Guile (compiler, debugger, REPL,
|
||
Unicode, libraries, etc.) And it means that we have a general-purpose
|
||
language, on top of which we can have embedded domain-specific languages
|
||
(EDSLs), such as the one used to define packages. This broadens what
|
||
can be done in package recipes themselves, and what can be done around them.
|
||
|
||
Technically, Guix makes remote procedure calls to the ‘nix-worker’
|
||
daemon to perform operations on the store. At the lowest level, Nix
|
||
“derivations” represent promises of a build, stored in ‘.drv’ files in
|
||
the store. Guix produces such derivations, which are then interpreted
|
||
by the daemon to perform the build. Thus, Guix derivations can use
|
||
derivations produced by Nix (and vice versa).
|
||
|
||
With Nix and the [[http://nixos.org/nixpkgs][Nixpkgs]] distribution, package composition happens at
|
||
the Nix language level, but builders are usually written in Bash.
|
||
Conversely, Guix encourages the use of Scheme for both package
|
||
composition and builders. Likewise, the core functionality of Nix is
|
||
written in C++ and Perl; Guix relies on some of the original C++ code,
|
||
but exposes all the API as Scheme.
|
||
|
||
* Related software
|
||
|
||
- [[http://nixos.org][Nix, Nixpkgs, and NixOS]], functional package manager and associated
|
||
software distribution, are the inspiration of Guix
|
||
- [[http://www.gnu.org/software/stow/][GNU Stow]] builds around the idea of one directory per prefix, and a
|
||
symlink tree to create user environments
|
||
- [[http://www.pvv.ntnu.no/~arnej/store/storedoc_6.html][STORE]] shares the same idea
|
||
- [[https://live.gnome.org/OSTree/][GNOME's OSTree]] allows bootable system images to be built from a
|
||
specified set of packages
|
||
- The [[http://www.gnu.org/s/gsrc/][GNU Source Release Collection]] (GSRC) is a user-land software
|
||
distribution; unlike Guix, it relies on core tools available on the
|
||
host system
|