summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)Author
2022-12-07services: zabbix: Don't write user to configuration file.Marius Bakke
The service already runs with the specified user and group, so there is no use in writing it to the configuration files. This change is mainly done for compatibility with 'zabbix-agent2' which does not understand the User= setting, but also to document the correct data type for the "group" setting. * gnu/services/monitoring.scm (serialize-string): Filter USER and GROUP fields. (group?, serialize-group): Remove variables. (zabbix-server-configuration, zabbix-agent-configuration): Document the GROUP field as 'string'. * doc/guix.texi (Monitoring Services): Adjust accordingly.
2022-12-02doc: Recommend 'match-record'.Ludovic Courtès
* doc/contributing.texi (Data Types and Pattern Matching): Recommend 'match-record'.
2022-12-01gnu: bootloader: Rework chaining, add grub-efi-netboot-removable-bootloader.Stefan
This rework allows to use an (efi-bootloader-chain) like this, which is able to boot over network or local storage, depending on whether the bootloader target has support for symbolic links: (operating-system (bootloader (bootloader-configuration (bootloader (efi-bootloader-chain grub-efi-netboot-removable-bootloader #:packages (list my-firmware-package my-u-boot-package) #:files (list (plain-file "config.txt" "kernel=u-boot.bin")) #:hooks my-special-bootloader-profile-manipulator)) (targets '("/booti/efi")) …)) …) * doc/guix.texi (Bootloader Configuration): Describe the new ‘grub-efi-netboot-removable-bootloader’. Mention the file names used and that the UEFI Boot Manager is not modified. Advise to disable write-access over TFTP. * gnu/bootloader.scm (efi-bootloader-profile): Allow a list of packages and collect everything directly in the profile, avoiding a separate collection directory. Renamed the profile from "bootloader-profile" to "efi-bootloader-profile". [bootloader-collection]: Rename to... [efi-bootloader-profile-hook]: ... this and remove unused modules. Do not create the now extraneous collection directory. (efi-bootloader-chain): Add PACKAGES and DISK-IMAGE-INSTALLER arguments. Remove handling of the collection directory, now only calling the given installer procedure. * gnu/bootloader/grub.scm (make-grub-efi-netboot-installer): New helper. (make-grub-configuration): New helper based on (grub-configuration-file). Add a GRUB argument, fix indentation, remove previous code retrieving GRUB from CONFIG. (grub-configuration-file): Make use of make-grub-configuration. (grub-efi-configuration-file): New procedure. (grub-cfg): New variable to replace "/boot/grub/grub.cfg". (install-grub-efi-netboot): Remove, splitting logic to... (make-grub-efi-netboot-installer): ... this new helper procedure, as well as to make-grub-efi-netboot, added below. (grub-bootloader): Adjust to use the GRUB-CFG. (grub-efi-bootloader): Likewise. Removed inheritance and declare all fields explicitly. (make-grub-efi-netboot-bootloader): New procedure. (grub-efi-netboot-bootloader): Use it. (grub-efi-netboot-removable-bootloader): New variable. * gnu/packages/bootloaders.scm (make-grub-efi-netboot): New procedure. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Modified-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2022-12-01services: network-manager: Add iwd backend support.Andrew Tropin
* gnu/services/networking.scm (network-manager-configuration)[iwd?]: New field. (network-manager-shepherd-service): Add iwd to requirements if needed. * doc/guix.texi: Add information about iwd? option.
2022-11-29doc: Remove unimplemented 'herd rules udev'.Maxim Cournoyer
Since this text was added, the rules.d directory is now exposed straightforwardly via the standard /etc/udev/rules.d directory, so there's no need for a special 'rules' service action to print that directory. * doc/guix.texi (Base Services): Remove the paragraph documenting the nonexistent 'herd rules udev' command.
2022-11-28doc: Recommend avoiding execl, execle or execlp in mcron job specifications.Maxim Cournoyer
* doc/guix.texi (Scheduled Job Execution): Adjust the 'updatedb' example and add a new tip.
2022-11-27doc: cookbook: Fix commands in example.Florian Pelz
Fixes <https://issues.guix.gnu.org/59463>. Reported by Luca Cirrottola <luca.cirrottola@inria.fr>. * doc/guix-cookbook.texi (Reproducible profiles): Make it work.
2022-11-24doc: Add a security keys section to the cookbook.Maxim Cournoyer
* doc/guix-cookbook.texi (Top): Register new menu. (System Configuration): Likewise. (Using security keys): New section.
2022-11-20doc: Note that ‘guix package’ accepts file names.Tobias Geerinckx-Rice
* doc/guix.texi (Package Management)[Invoking guix package]: Mention support for operating on store file names. Co-authored-by: Tobias Geerinckx-Rice <me@tobias.gr>
2022-11-23offload: Increase default 'overload-threshold' value.Ludovic Courtès
When offloading to a single machine, the previous default value would lead 'guix offload' to wait possibly for several minutes between subsequent builds until normalized load would finally go below 0.6. Increasing it mitigates that. * guix/scripts/offload.scm (<build-machine>)[overload-threshold]: Bump to 0.8. * doc/guix.texi (Daemon Offload Setup): Likewise.
2022-11-22doc: Call out potential for security vulnerabilities in old software.pelzflorian (Florian Pelz)
* doc/guix.texi (Invoking guix time-machine): Add a note. Co-authored by: Simon Tournier <zimon.toutoune@gmail.com>
2022-11-21guix: modify-input: Recommend prepend instead of append.Vivien Kraus
* doc/guix.texi (Defining Package Variants): Document the "prepend" clause of modify-inputs first. * guix/packages.scm (modify-inputs): use "prepend" in the docstring. Signed-off-by: Christopher Baines <mail@cbaines.net>
2022-11-19doc: Build more man pages.Hilton Chain
* doc/local.mk (sub_commands_mans): Add guix-container.1, guix-copy.1, guix-describe.1, guix-git.1, guix-graph.1, guix-home.1, guix-offload.1, guix-pack.1, guix-processes.1, guix-repl.1, guix-shell.1, guix-style.1. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-11-18services: Add Shepherd 'configuration' action to various services.Ludovic Courtès
* gnu/services/avahi.scm (avahi-shepherd-service): Add 'actions' field. * gnu/services/base.scm (nscd-actions): Add call to 'shepherd-configuration-action'. * gnu/services/desktop.scm (upower-shepherd-service): Add 'actions' field. (elogind-shepherd-service): Likewise. * gnu/services/dict.scm (dicod-shepherd-service): Likewise. * gnu/services/networking.scm (openntpd-shepherd-service): Likewise. (tor-shepherd-service): Likewise. * gnu/services/ssh.scm (openssh-shepherd-service): Likewise. * gnu/services/web.scm (nginx-shepherd-service): Likewise. * gnu/services/xorg.scm (gdm-shepherd-service): Likewise. * gnu/tests/base.scm (run-basic-test)["nscd configuration action"]: New test. * doc/guix.texi (Services): Document it.
2022-11-18services: shepherd: Define 'shepherd-configuration-action' helper.Ludovic Courtès
* gnu/services/shepherd.scm (shepherd-configuration-action): New * doc/guix.texi (Shepherd Services): Document it.
2022-11-18linux-initrd: raw-initrd: Add keyword argument #:pre-mount.Hilton Chain
* gnu/system/linux-initrd.scm (raw-initrd): Add keyword argument #:pre-mount. Document it. * doc/guix.texi (initial RAM disk): Likewise. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-11-17Revert "services: configuration: Revert to a working ‘guix home’."Maxim Cournoyer
This reverts commit 39e4e00f75be8055300cb0afffb8bd4b4d35f2cc, with fixes for the guix home issues reported and another one found while reconfiguring berlin in the subsequent commit.
2022-11-13services: configuration: Revert to a working ‘guix home’.Tobias Geerinckx-Rice
This reverts commit 543d971ed2a1d9eb934af1f51930741d7cc4e7ef, and its dependent commit 9b21cd2e9a614f1937769caf3917a791b151d841, which appear to have triggered a recent wave of ‘guix home’ regressions involving (services (list (service home-bash-service-type))): In gnu/home/services/shells.scm: 504:7 3 (home-bash-extensions #<<home-bash-configuration> package: #<package bash@5.1.8 gnu/packages/ba…> …) In unknown file: 2 (append #<<location> file: "…" line: 14 column: 12> ()) In ice-9/boot-9.scm: 1685:16 1 (raise-exception _ #:continuable? _) 1685:16 0 (raise-exception _ #:continuable? _) ice-9/boot-9.scm:1685:16: In procedure raise-exception: In procedure append: Wrong type argument in position 1 (expecting empty list): #<<location> file: "…" line: 14 column: 12> I should love to dive in & fix this rather than revert, but urgently need sleep.
2022-11-15services: mcron: Add log? and log-format fields to mcron-configuration.Maxim Cournoyer
* gnu/services/mcron.scm (list-of-gexps?): New predicate. (mcron-configuration): Rewrite using define-configuration. [log?, log-format]: New fields. (mcron-shepherd-services): Invoke mcron with the --log and --log-format arguments when log? is #t, (generate-doc): New procedure. * doc/guix.texi (Scheduled Job Execution): Update doc. (Mcron Home Service): Likewise. * gnu/home/services/mcron.scm: Keep in sync with the above changes to gnu/services/mcron.scm.
2022-11-15guix: shell: Add '--symlink' option.Maxim Cournoyer
* guix/scripts/pack.scm (%options): Extract symlink parsing logic to... (symlink-spec-option-parser): ... here. (self-contained-tarball/builder): Add a comment mentioning why a relative file name is used for the link target. * guix/scripts/environment.scm (show-environment-options-help): Document new --symlink option. (%default-options): Add default value for symlinks. (%options): Register new symlink option. (launch-environment/container): Add #:symlinks argument and extend doc, and create symlinks using evaluate-populate-directive. (guix-environment*): Pass symlinks arguments to launch-environment/container. * doc/guix.texi (Invoking guix shell): Document it. * tests/guix-shell.sh: Add a --symlink (negative) test. * tests/guix-environment-container.sh: Add tests.
2022-11-15doc: Add missing closing parentheses in examples.Ludovic Courtès
* doc/guix.texi (VNC Services, Guix Home Services): Add missing closing parentheses.
2022-11-15doc: Link to the Git book instead of the git-scm.com homepage.pelzflorian (Florian Pelz)
The Pro Git book, unlike the git-scm.com homepage, is translated to many languages. Therefore translators of the Guix Manual can point to the appropriate translation now. * doc/guix.texi (Invoking guix pull): Point to the Pro Git book's URL. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-11-15doc: Build pt_BR manual.Ludovic Courtès
* doc/build.scm (%manual-languages): Add "pt_BR".
2022-11-15doc: Refer to the pt_BR translation.pelzflorian (Florian Pelz)
* doc/guix.texi (Top): Mention Brazilian Portuguese. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-11-15installer: Report known-unsupported PCI devices.Ludovic Courtès
* gnu/installer/hardware.scm: New file. * gnu/local.mk (INSTALLER_MODULES): Add it. * po/guix/POTFILES.in: Add it. * gnu/installer.scm (installer-steps): Pass #:pci-database to the 'welcome' step procedure. * gnu/installer/newt.scm (welcome-page): Add #:pci-database and pass it to 'run-welcome-page'. * gnu/installer/newt/welcome.scm (check-hardware-support): Add #:pci-database. Enumerate unsupported PCI devices and run an error page when unsupported devices are found. (run-welcome-page): Add #:pci-database and pass it to 'check-hardware-support' and to the recursive call. * gnu/installer/record.scm (<installer>)[welcome-page]: Adjust comment. * doc/guix.texi (Hardware Considerations): Mention it.
2022-11-07services: gitolite: Add local-code configuration option.Alexey Abramov
* gnu/services/version-control.scm (gitolite-rc-file): Add local-code field. (gitolite-rc-file-compiler): Serialize the field. * doc/guix.texi: Document it. Signed-off-by: Christopher Baines <mail@cbaines.net>
2022-11-06guix gc: Add '--vacuum-database'.Efraim Flashner
* guix/scripts/gc.scm (show-help, %options): Add '--vacuum-database'. * guix/store/database.scm (vacuum-database): New procedure. * doc/guix.texi (Invoking guix gc): Document the option.
2022-11-06doc: cookbook: Add section on MPD with bluealsa.Ricardo Wurmus
* doc/guix-cookbook.texi (Music Server with Bluetooth Audio): New section under System Configuration.
2022-11-06doc: cookbook: Update detailed menu for "System Configuration".Ricardo Wurmus
* doc/guix-cookbook.texi: Update menu.
2022-11-03services: ganeti: OS variants can be a directory.Marius Bakke
* gnu/services/ganeti.scm (<ganeti-os>)[extension]: Default to #f. (ganeti-os->directory): Only add extension if set. Support a file-like object for VARIANTS. * doc/guix.texi (Virtualization Services): Document this change and add example. Update Ganeti URLs while at it.
2022-11-03doc: Change example for special-files-service-type.EuAndreh
Also update the default value given in the docs. Change the example since the base system includes /usr/bin/env by default. * doc/guix.texi (Base Services): Change the example for special-files-service-type and update default. Signed-off-by: Christopher Baines <mail@cbaines.net>
2022-11-01doc: contributing: Use proper subsections.(
* doc/contributing.texi ("Submitting Patches") ["Sending a Patch Series", "Teams"]: Convert to numbered subsections. Add nodes. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2022-10-28doc: contributing: Expand "Sending a Patch Series".(
* doc/contributing.texi: Expand on sending patches and using git send-email. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2022-10-27build-system/pyproject: Always run tests verbosely for supported backends.Marius Bakke
* guix/build-system/pyproject.scm (pyproject-build): Default to '() instead of #false for TEST-FLAGS. * guix/build/pyproject-build-system.scm (check): Unconditionally enable verbose test flags. * doc/guix.texi (Build Systems): Document this change. * gnu/packages/fontutils.scm (python-glyphslib)[arguments]: Remove verbosity from #:test-flags. * gnu/packages/pdf.scm (python-pydyf, weasyprint)[arguments]: Likewise. * gnu/packages/python-web.scm (python-openapi-spec-validator)[arguments]: Likewise. * gnu/packages/python-xyz.scm (python-path, python-tempora)[arguments]: Likewise.
2022-10-27build-system: Add pyproject-build-system.Lars-Dominik Braun
This is an experimental build system based on python-build-system that implements PEP 517-compliant builds. * doc/guix.texi (Build Systems): Add pyproject-build-system section. * doc/contributing.texi (Python Modules): Mention pyproject.toml and the PYTHON-TOOLCHAIN package, as well as differences to python-build-system. * guix/build-system/pyproject.scm, guix/build/pyproject-build-system.scm, gnu/packages/aux-files/python/sanity-check-next.py, gnu/packages/python-commencement.scm: New files. * Makefile.am (MODULES): Register the new build systems. * gnu/local.mk (GNU_SYSTEM_MODULES): Add python-commencement.scm. * gnu/packages/python.scm (python-sans-pip, python-sans-pip-wrapper): New variables. Co-authored-by: Marius Bakke <marius@gnu.org>
2022-10-24gnu: version-control: Add make-gitolite procedure.David Thompson
* gnu/packages/version-control.scm (make-gitolite): New procedure. (gitolite): Use make-gitolite. * doc/guix.texi (Gitolite service): Document how to use make-gitolite.
2022-10-20file-systems: Support the 'no-diratime' mount flag.Ludovic Courtès
* gnu/build/file-systems.scm (mount-flags->bit-mask): Handle 'no-diratime'. * doc/guix.texi (File Systems): Document it.
2022-10-20services: wireguard: Add more configuration fields.Mathieu Othacehe
* gnu/services/vpn.scm (<wireguard-configuration>)[pre-up, post-up, pre-down, post-down, table]: New fields. (wireguard-configuration-file): Take them into account. * doc/guix.texi (Wireguard): Update it.
2022-10-18doc: Mention Guile-GnuTLS in the requirements.Ludovic Courtès
* doc/guix.texi (Requirements): Update.
2022-10-17channels: Interpret the 'commit' field of channel as a tag or commit.Ludovic Courtès
Previously the 'commit' field would always be interpreted as a commit ID. This change adds flexibility, allowing for things like: guix time-machine --commit=v1.2.0 -- describe * guix/channels.scm (channel-reference): Use 'tag-or-commit' rather than 'commit'. * guix/inferior.scm (channel-full-commit): Likewise. * doc/guix.texi (Invoking guix pull): Document it. (Invoking guix time-machine): Likewise.
2022-10-17doc: Fix typos.Julien Lepiller
These typos were found and reported on weblate. * doc/guix.texi: Fix typos.
2022-10-15doc: Explain Emacs native-compilation.zimoun
* doc/guix.texi ("Application Setup")["Emacs Packages"]: Add a note explaining that Emacs can compile packages to native code now. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2022-10-13doc: Add chapter on containers to Cookbook.Ricardo Wurmus
* doc/guix-cookbook.texi (Containers): New chapter.
2022-10-13environment: Add '--emulate-fhs'.John Kehayias
* guix/scripts/environment.scm (show-environment-options-help, %options): Add '--emulate-fhs'. (setup-fhs): New procedure. Setup for the Filesystem Hierarchy Standard (FHS) container. Defines and uses FHS-SYMLINKS and LINK-CONTENTS to create FHS expected directories and creates /etc/ld.so.conf. (launch-environment): Add 'emulate-fhs?' key and implement it to set $PATH and generate /etc/ld.so.cache before calling COMMAND. (launch-environment/container): Add 'emulate-fhs?' and 'setup-hook' keys and implement them. Define and use FHS-MAPPINGS, to set up additional bind mounts in the container to follow FHS expectations. (guix-environment*): Add glibc-for-fhs to the container packages when 'emulate-fhs?' key is in OPTS. * doc/guix.texi (Invoking guix shell): Document '--emulate-fhs'. (Invoking guix environment): Document '--emulate-fhs'. * tests/guix-environment-container.sh: Add tests for '--emulate-fhs'. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2022-10-13gnu: home: Add home-dbus-service-type.( via Guix-patches via
* gnu/home/services/desktop.scm (home-dbus-service-type): New variable. (home-dbus-configuration): New record type. * doc/guix.texi: Document them. Signed-off-by: Andrew Tropin <andrew@trop.in>
2022-10-11system: operating-system: Make the timezone field default to Etc/UTC.Maxim Cournoyer
* gnu/system.scm (<operating-system>) [timezone]: Default to "Etc/UTC".
2022-10-11gnu: base: Add greetd-wlgreet-sway-session.(
* gnu/services/base.scm (greetd-wlgreet-session): New data type. (greetd-wlgreet-sway-session): Likewise. * doc/guix.texi ("Base Services")[greetd-service-type]: Document them. Signed-off-by: Christopher Baines <mail@cbaines.net>
2022-10-11services: guix: Include max-allocated-builds gbc agent option.Christopher Baines
* gnu/services/guix.scm (guix-build-coordinator-agent-configuration-max-allocated-builds): New procedure. (guix-build-coordinator-agent-shepherd-services): Use max-allocated-builds. * doc/guix.texi (Guix Build Coordinator): Document this new field.
2022-10-07Revert "Revert "services: Add xvnc-service-type.""Maxim Cournoyer
This reverts commit 0c4966160054bc50e6ab3a4ac9c9a6a1826ab5a0. The fix appears in the subsequent commit, for clarity.
2022-10-07Revert "services: Add xvnc-service-type."Maxim Cournoyer
This reverts commit 1c528a95cb92b7808e6603d7956185005583629f. This broke 'guix pull', for (yet) unknown reasons.