---

22.7 Source Tree Structure

If you’re willing to contribute to Guix beyond packages, or if you’d like to learn how it all fits together, this section provides a guided tour in the code base that you may find useful.

Overall, the Guix source tree contains almost exclusively Guile modules, each of which can be seen as an independent library (see Modules in GNU Guile Reference Manual).

The following table gives an overview of the main directories and what they contain. Remember that in Guile, each module name is derived from its file name—e.g., the module in file guix/packages.scm is called (guix packages).

guix

This is the location of core Guix mechanisms. To illustrate what is meant by “core”, here are a few examples, starting from low-level tools and going towards higher-level tools:

(guix store)

Connecting to and interacting with the build daemon (see The Store).

(guix derivations)

Creating derivations (see Derivations).

(guix gexps)

Writing G-expressions (see G-Expressions).

(guix packages)

Defining packages and origins (see package Reference).

(guix download)

(guix git-download)

The url-fetch and git-fetch origin download methods (see origin Reference).

(guix swh)

Fetching source code from the Software Heritage archive.

(guix search-paths)

Implementing search paths (see Search Paths).

(guix build-system)

The build system interface (see Build Systems).

(guix profiles)

Implementing profiles.

guix/build-system

This directory contains specific build system implementations (see Build Systems), such as:

(guix build-system gnu)

the GNU build system;

(guix build-system cmake)

the CMake build system;

(guix build-system pyproject)

The Python “pyproject” build system.

guix/build

This contains code generally used on the “build side” (see strata of code). This includes code used to build packages or other operating system components, as well as utilities:

(guix build utils)

Utilities for package definitions and more (see Build Utilities).

(guix build gnu-build-system)

(guix build cmake-build-system)

(guix build pyproject-build-system)

Implementation of build systems, and in particular definition of their build phases (see Build Phases).

(guix build syscalls)

Interface to the C library and to Linux system calls.

guix/scripts

This contains modules corresponding to guix sub-commands. For example, the (guix scripts shell) module exports the guix-shell procedure, which directly corresponds to the guix shell command (see Invoking guix shell).

guix/import

This contains supporting code for the importers and updaters (see Invoking guix import, and see Invoking guix refresh). For example, (guix import pypi) defines the interface to PyPI, which is used by the guix import pypi command.

The directories we have seen so far all live under guix/. The other important place is the gnu/ directory, which contains primarily package definitions as well as libraries and tools for Guix System (see System Configuration) and Guix Home (see Home Configuration), all of which build upon functionality provided by (guix …) modules⁴⁶.

gnu/packages

This is by far the most crowded directory of the source tree: it contains package modules that export package definitions (see Package Modules). A few examples:

(gnu packages base)

Module providing “base” packages: glibc, coreutils, grep, etc.

(gnu packages guile)

Guile and core Guile packages.

(gnu packages linux)

The Linux-libre kernel and related packages.

(gnu packages python)

Python and core Python packages.

(gnu packages python-xyz)

Miscellaneous Python packages (we were not very creative).

In any case, you can jump to a package definition using guix edit (see Invoking guix edit) and view its location with guix show (see Invoking guix package).

gnu/packages/patches

This directory contains patches applied against packages and obtained using the search-patches procedure.

gnu/services

This contains service definitions, primarily for Guix System (see Services) but some of them are adapted and reused for Guix Home as we will see below. Examples:

(gnu services)

The service framework itself, which defines the service and service type data types (see Service Composition).

(gnu services base)

“Base” services (see Base Services).

(gnu services desktop)

“Desktop” services (see Desktop Services).

(gnu services shepherd)

Support for Shepherd services (see Shepherd Services).

You can jump to a service definition using guix system edit and view its location with guix system search (see Invoking guix system).

gnu/system

These are core Guix System modules, such as:

(gnu system)

Defines operating-system (see operating-system Reference).

(gnu system file-systems)

Defines file-system (see File Systems).

(gnu system mapped-devices)

Defines mapped-device (see Mapped Devices).

gnu/build

These are modules that are either used on the “build side” when building operating systems or packages, or at run time by operating systems.

(gnu build accounts)

Creating /etc/passwd, /etc/shadow, etc. (see User Accounts).

(gnu build activation)

Activating an operating system at boot time or reconfiguration time.

(gnu build file-systems)

Searching, checking, and mounting file systems.

(gnu build linux-boot)

(gnu build hurd-boot)

Booting GNU/Linux and GNU/Hurd operating systems.

(gnu build linux-initrd)

Creating a Linux initial RAM disk (see Initial RAM Disk).

gnu/home

This contains all things Guix Home (see Home Configuration); examples:

(gnu home services)

Core services such as home-files-service-type.

(gnu home services ssh)

SSH-related services (see Secure Shell).

gnu/installer

This contains the text-mode graphical system installer (see Guided Graphical Installation).

gnu/machine

These are the machine abstractions used by guix deploy (see Invoking guix deploy).

gnu/tests

This contains system tests—tests that spawn virtual machines to check that system services work as expected (see Running the Test Suite).

Last, there’s also a few directories that contain files that are not Guile modules:

nix

This is the C++ implementation of guix-daemon, inherited from Nix (see Invoking guix-daemon).

tests

These are unit tests, each file corresponding more or less to one module, in particular (guix …) modules (see Running the Test Suite).

doc

This is the documentation in the form of Texinfo files: this manual and the Cookbook. See Writing a Texinfo File in GNU Texinfo, for information on Texinfo markup language.

po

This is the location of translations of Guix itself, of package synopses and descriptions, of the manual, and of the cookbook. Note that .po files that live here are pulled directly from Weblate (see Translating Guix).

etc

Miscellaneous files: shell completions, support for systemd and other init systems, Git hooks, etc.

With all this, a fair chunk of your operating system is at your fingertips! Beyond grep and git grep, see The Perfect Setup on how to navigate code from your editor, and see Using Guix Interactively for information on how to use Scheme modules interactively. Enjoy!