summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-01-09doc: cookbook: Add "Installing Guix on a Cluster" chapter.Ludovic Courtès
This is derived from the article at <https://hpc.guix.info/blog/2017/11/installing-guix-on-a-cluster/>, with clarifications and updates. * doc/guix-cookbook.texi (Installing Guix on a Cluster): New chapter.
2023-01-09services: base: Add environment support to guix-configuration.Mathieu Othacehe
* gnu/services/base.scm (<guix-configuration>)[extra-env]: New field. (guix-shepherd-service): Honor it. * doc/guix.texi (Base Services): Document it.
2023-01-07Revert "services: base: Add extra-env support to guix-configuration."Mathieu Othacehe
This reverts commit 78a9b4f996ba18b4460ba380b87e9538007c27e0. It was pushed by error, while not reviewed yet.
2023-01-07services: base: Add extra-env support to guix-configuration.Mathieu Othacehe
* gnu/services/base.scm (<guix-configuration>)[extra-env]: New field. (guix-shepherd-service): Honor it. * doc/guix.texi (Base Services): Document it.
2023-01-06doc: cookbook: Remove 404 link to mitpress.mit.edu.Ludovic Courtès
* doc/guix-cookbook.texi (A Scheme Crash Course): Remove 404 link to mitpress.mit.edu.
2023-01-05doc: Introduce using swap space for hibernation, with examples.Ivan Vilata-i-Balaguer
* doc/guix.texi (Swap Space): Add a concise introduction to hibernation and specifying a swap space to the kernel to make resume work. Mention space requirements and the need of an offset for swap files. Include a trivial example on how to set up a mapped swap volume for hibernation and another one for a swap file, including how to compute the file offset. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2023-01-05home: services: environment-variables: Add support for literal strings.Ludovic Courtès
* gnu/home/services.scm (<literal-string>): New record type. (environment-variable-shell-definitions): Split 'shell-quote' into 'quote-string' and 'shell-double-quote'. Add 'shell-single-quote'. Add clause for 'literal-string' records. * tests/guix-home.sh: Test it. * doc/guix.texi (Essential Home Services): Document it.
2023-01-03doc: Fix broken link for go-build-system.Bruno Victal
* doc/guix.texi (Build Systems): Fix broken link for go-build-system. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2022-12-31import/cran: Allow custom license prefix.Lars-Dominik Braun
* guix/import/cran.scm (string-licenses): Add license-prefix argument. (string->license): Ditto. (description->package): Ditto. (cran->guix-package): Ditto. (cran-recursive-import): Ditto. * guix/scripts/import/cran.scm (%options): Add new option -p/--license-prefix. (show-help): Document it. (parse-options): Pass it to importer. * doc/guix.texi (Invoking guix import): Document it.
2022-12-29doc: Give example of when to use describe in .guix-channel file.Karl Hallsby
* doc/guix.texi (Package Modules in a Sub-directory): Mention "guix deploy" files as an example. Signed-off-by: Ricardo Wurmus <rekado@elephly.net>
2022-12-29doc: Describe format of channel that uses directory field.Karl Hallsby
* doc/guix.texi (Package Modules in a Sub-directory): Explain that directory must be the module root.
2022-12-28doc: Update expired URL.Marius Bakke
* doc/guix.texi (DNS Services): Update knot-resolver documentation link.
2022-12-26doc: Describe how to update to a specific version.Hartmut Goebel
* doc/guix.texi (Invoking guix refresh): Describe how to update to a specific version.
2022-12-26gnu: services: Fix bluetooth-service docstring.Ivan Vilata i Balaguer
* gnu/services/desktop.scm (bluetooth-service): Sync docstring with info, remove mention to group not really needed to access D-Bus service. * doc/guix.texi (Desktop Services): Also remove mention to group here. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-12-25services: wireguard: Allow specifying pre-shared keys.Timo Wilken
* gnu/services/vpn.scm (<wireguard-peer>)[preshared-key]: New field. * doc/guix.texi (VPN Services): Document it. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2022-12-18doc: Fix typo.Tobias Geerinckx-Rice
* doc/contributing.texi (Sending a Patch Series): Fix e-mail address of <guix-patches@gnu.org>. Reported by Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>.
2022-12-23doc: Wrap $localstatedir in Texinfo syntax.Ricardo Wurmus
* doc/guix.texi (Limitations): Use @file syntax.
2022-12-23doc: Suggest remounting store before relabeling the file system.Ricardo Wurmus
* doc/guix.texi (Installing the SELinux policy): Mention that the store may need to be remounted before writing to it.
2022-12-20services: opensmtpd: Add 'shepherd-requirement' field.Bruno Victal
* gnu/services/mail.scm (<opensmtpd-configuration>)[shepherd-requirement]: New field. (opensmtpd-shepherd-service): Honor it. * doc/guix.texi (Mail Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-12-20doc: Avoid 'match' on the <udev-configuration> record.Ludovic Courtès
Fixes <https://issues.guix.gnu.org/59907>. Reported by MANCINI Raffael <Raffael.MANCINI@mnhn.lu>. * doc/guix.texi (Service Types and Services): Change 'udev-configuration' example to avoid 'match'.
2022-12-19Merge branch 'version-1.4.0'Ludovic Courtès
2022-12-18doc: Tweak cross-ref Texinfo command.Ludovic Courtès
* doc/guix.texi (Swap Space): Use @pxref instead of @xref at the end of a sentence.
2022-12-18doc: Update URLs for the manual and cookbook translations.Ludovic Courtès
* doc/htmlxref.cnf: Update URLs for "guix" and "guix-cookbook".
2022-12-18doc: Add guile-netlink to 'htmlxref.cnf'.Ludovic Courtès
* doc/htmlxref.cnf: Add guile-netlink.
2022-12-15doc: Use VM image file name consistently.Ludovic Courtès
Previously, what "/tmp/qemu-image" refers to could be unclear at first. * doc/guix.texi (Running Guix in a VM): Use the original image file name instead of /tmp/qemu-image. * po/doc/guix-manual.de.po, po/doc/guix-manual.es.po, po/doc/guix-manual.fr.po, po/doc/guix-manual.pt_BR.po, po/doc/guix-manual.ru.po, po/doc/guix-manual.zh_CN.po: Adjust accordingly.
2022-12-14doc: Fix formatting for 'computed-file'.Bruno Victal
* doc/guix.texi (G-Expressions): Fix formatting for 'computed-file'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-12-14doc: Verify the release with my own OpenPGP key.Ludovic Courtès
* doc/guix.texi (OPENPGP-SIGNING-KEY-ID, OPENPGP-SIGNING-KEY-URL): Switch to my key.
2022-12-17services: ganeti: Add support for cluster hooks.Marius Bakke
* gnu/services/ganeti.scm (<ganeti-configuration>): Add HOOKS. (hooks->directory): Rename to ... (debootstrap-hooks->directory): ... this, for clarity. (debootstrap-configuration-compiler): Adjust accordingly. (ganeti-directory): Add HOOKS when set. (ganeti-etc-service): Pass HOOKS. * doc/guix.texi (Virtualization Services): Mention it.
2022-12-14gnu: slapd-configuration: Update default for run-dir.Ricardo Wurmus
* gnu/services/ldap.scm (slapd-configuration): Update default value for run-dir to match defaults of 389-ds-base package. * doc/guix.texi: Update documentation.
2022-12-14gnu: Add directory-server-service-type.Ricardo Wurmus
* gnu/services/ldap.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (LDAP Services): Document it.
2022-12-14doc: Fix formatting for 'computed-file'.Bruno Victal
* doc/guix.texi (G-Expressions): Fix formatting for 'computed-file'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-12-13services: nix: Add more configuration fields.Petr Hodina
* gnu/services/nix.scm (<nix-configuration>)[build-directory]: New field. (nix-service-etc, nix-shepherd-service): Take them into account. * doc/guix.texi (Nix): Update it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-12-08doc: Recommend 'match-record'.Ludovic Courtès
* doc/contributing.texi (Data Types and Pattern Matching): Recommend 'match-record'.
2022-12-08doc: Replace reference to Freenode.Ludovic Courtès
* doc/guix.texi (Reduced Binary Seed Bootstrap): Libera.Chat, not Freenode.
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-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-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-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>
generated by cgit v1.2.3 (git 2.46.2) at 2024-12-29 10:54:59 +0000