summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2026-05-01build: Fix out-of-tree make.fix-out-of-tree-makeCharles Roelli
* doc/local.mk (lang_to_texinfo): Refer to .texi files using srcdir. (xref_command): Reference pre-inst-env using builddir. ($(srcdir)/%D%/guix.%.texi): ($(srcdir)/%D%/guix-cookbook.%.texi): ($(srcdir)/%D%/contributing.%.texi): Refer to source files using srcdir. * nix/local.mk (etc/guix-gc.timer): Use the name of the prerequisite, not just its file name. Change-Id: I247bcd873c8355d0eae07870ec849d2eb8cfa6c5
2026-04-30shell: Add --cwd.Danny Milosavljevic
* guix/scripts/environment.scm (show-environment-options-help): Document --cwd. (%options): Add cwd. (launch-environment/container): Add cwd parameter. Implement passing it to the container. (guix-environment*): Reject --cwd without --container. * doc/guix.texi (Invoking guix shell): Document it. * tests/guix-environment-container.sh: Add tests. * tests/guix-shell.sh: Add tests. Fixes: guix/guix# 7825 Change-Id: Iba4ff3d2058e92f504fbcbf688346357ce913213
2026-04-29docs: Update release signing key.Rutherther
The release artifacts are now signed by Efraim, not Ludo. * doc/guix-cookbook.texi: Switch gpg url to codeberg, mention Efraim's key. * doc/guix.texi: Likewise. Change-Id: Iae667796b6978cdd4a44f73990da7b9599ab509c Fixes: #5946 Signed-off-by: Rutherther <rutherther@ditigal.xyz> Merges: #6213
2026-04-28services: guix-data-service: Add extra environment variable options.Christopher Baines
Also export guix-data-service-extra-options and guix-data-service-extra-process-jobs-options since this was missed previously. * gnu/services/guix.scm (<guix-data-service-configuration>): Add extra-environment-variables and extra-process-jobs-environment-variables. (guix-data-service-shepherd-services): Use them. * doc/guix.texi (Guix Services): Document them. Change-Id: I60f1371a86a01c4fb3dbde204dba84b9a8657ace
2026-04-27doc: Make “Automatic LUKS Master Key Passing” an actual section.Ludovic Courtès
This is a followup to b90597b98d46767207a0e92a84fb39c344472b69, which added “Automatic LUKS Master Key Passing” in the documentation of the ‘device-tree-support?’ field. * doc/guix.texi (Bootloader Configuration): Move “Automatic LUKS Master Key Passing” as an actual subsection below the ‘bootloader-configuration’ doc. Add an anchor and index entries. Add @unnumberedsubsec for “Additional Boot Entries” and for “Themes” together with index entries Change-Id: I9e43d27b7294144288eb2a8ce1d7903da6dfae45 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #8162
2026-04-19doc: Further elucidate(?) the bcachefs situation.Tobias Geerinckx-Rice
This follows up on commit cd2d52bce2a89f5c3243d78979adbba7e00d3c55. Said support is <https://codeberg.org/guix/guix/pulls/1917>, but linking to PRs in the documentation is a bit much. The git log is much better. * doc/guix.texi (Keyboard Layout and Networking and Partitioning): One cannot, in fact, load the bcachefs module on an unpatched Guix System. Change-Id: Ib04cc97cf7cffc1e7d130d4dd43e422afaef55ee
2026-04-23doc: Add a note reminder to checkout the correct tag for rust crates.Murilo
* doc/guix-cookbook.texi (Packaging Workflows)[Packaging Rust Crates] {Common Workflow for Rust Packaging}: Add the note. Change-Id: I670c78d7cd6771b5f4814123e488cbdb1c4e9fe2 Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-23doc: Add new workflow for resolving merge conflicts on rust apps PRs.Murilo
* doc/guix-cookbook.texi (Packaging Workflows)[Packaging Rust Crates] {Common Workflow for Updating Existing Rust Packages}: Add new workflow. Change-Id: I191d35790754b2fab4c27b794829959f1bf58d06 Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-23doc: Recommend a way of resolving merge conflicts for rust PRs.Murilo
* doc/contributing.texi (Rust Crates) [Resolving merge conflicts in Pull Requests]: New subsubsection. Change-Id: Icbc5e2da01b6068b6237548f2bd49262433799de Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-23doc: Add new workflow for resolving merge conflicts on rust crate PRs.Murilo
* doc/guix-cookbook.texi (Packaging Workflows)[Packaging Rust Crates] {Common Workflow for Resolving Merge Conflicts on Existing Pull Requests}: Add new workflow. Change-Id: I6e5cbf843174049e1dbde17ecd1ea259b4fa4aae Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-23doc: Add rust commit messages guidance.Murilo
* doc/contributing.texi (Rust Crates)[Commit messages]: New subsubsection. Change-Id: If22d6921301902417a88d2d5d8e2fad947762bee Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-23doc: Clarify that rust crate changes should be done in the same commit.Murilo
* doc/contributing.texi (Rust Crates): Add clarification. Change-Id: Iff45cda11b14640a70a2849fe66ae68f46cb3ba9 Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-04-23services: kmonad: New service.Sergio Pastor Pérez
* gnu/services/desktop.scm (<kmonad-configuration>) (kmonad-shepherd-service, kmonad-service-type): New variables. * doc/guix.texi (Desktop Services): Document `kmonad-service-type'. Change-Id: I53f868d55aea97858ec83d762a04723d3c72dc92 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2026-04-20doc: Mention the GCD process.Ludovic Courtès
* doc/contributing.texi (Making Decisions): Document GCDs. Change-Id: I8b247af4e6ec731bc7750e19519c8dba863e5ef5 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #7786
2026-04-20doc: Document ‘package/inherit’.Ludovic Courtès
* doc/guix.texi (Defining Package Variants): Document ‘package/inherit’. Change-Id: I373b54d3a6978d7d2719a234b244397f68004818 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #7784
2026-04-20doc: Add missing markup in “Invoking guix refresh”.Ludovic Courtès
* doc/guix.texi (Invoking guix refresh): Add missing @option. Change-Id: I898d2d4d6fac8a05281a43043e1eaba36cd57869 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-04-20doc: Fix typographical issues in “Invoking guix style”.Ludovic Courtès
* doc/guix.texi (Invoking guix style): Fix typographic issues. Use less horizontal space in example. Change-Id: Ibc8c89e4f0ae1f8ea03c4d706280b424533b0e48 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-04-17home: services: gpg-agent: Expose shepherd-requirement in configuration.Hilton Chain
* gnu/home/services/gnupg.scm (home-gpg-agent-configuration) [shepherd-requirement]: New field. (home-gpg-agent-shepherd-services): Use it. * doc/guix.texi (GNU Privacy Guard): Update documentation. Merges: #7788
2026-04-15guix: Implement fossil-download.Nguyễn Gia Phong
* guix/fossil-download.scm: New file. * guix/build/fossil.scm: New file. * Makefile.am (MODULES): Add them. * etc/teams.scm (core)[#:scope]: Add "guix/fossil-download.scm". (vcs)[#:scope]: Add "guix/build/fossil.scm". * CODEOWNERS: Regenerate file. * doc/guix.texi (origin Reference): Document fossil-fetch and fossil-reference. * NEWS: Add entry about fossil-fetch. Change-Id: Ia252bcbbb417159a842d5092a937e2aad55a1656 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2026-04-12services: configuration: Add environment variable serializer.Giacomo Leidi
This patch implements a general API to serialize configuration records to list of pairs representing environment variables. The car of each pair represents the variable name and the cdr the variable value. * gnu/services/configuration/environment-variables.scm: New file. (serialize-string-environment-variable) (serialize-maybe-string-environment-variable) (serialize-boolean-environment-variable) (serialize-maybe-boolean-environment-variable) (serialize-number-environment-variable) (serialize-maybe-number-environment-variable): New variables. (serialize-environment-variables): New variable. * gnu/services/configuration/utils.scm: New file. (uglify-snake-case): New variable. * tests/services/configuration.scm: Add tests for environment serializer. (wrong type for a field): Adjust error location. * doc/guix.texi: Document it. Change-Id: I81a166576f94d3c8f5bf78c82a02183689a3091c Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2026-04-09guix: Ask LUKS password only once on boot when using GRUB.Danny Milosavljevic
* gnu/bootloader/grub.scm (make-grub-configuration): Modify. * gnu/system/mapped-devices.scm (open-luks-device): Modify. * gnu/tests/install.scm (%encrypted-root-installation-script): Modify. (%encrypted-root-os): Make debugging possible. * doc/guix.texi (Mapped Devices): Cross-reference automatic LUKS master key passing. (BootloaderConfiguration): Document automatic LUKS master key passing via GRUB's (proc)/luks_script. Update extra-initrd documentation. Change-Id: I5be74a524de04232d156e750109707fe7e50c28a
2026-04-07doc: Fix documentation of the name service switch.Maxim Cournoyer
The previously referenced `nscd-service' procedure no longer exists. * doc/guix.texi (Name Service Switch): Adjust to refer to nscd-service-type and its nscd-configuration configuration record. Change-Id: Ib2b5ef69facf3489626782ad9dbd927a27c04084
2026-03-29doc: Add bcachefs to supported file systems footnote.Tobias Geerinckx-Rice
* doc/guix.texi (Keyboard Layout and Networking and Partitioning): Mention bcachefs as supported, provided you load the module. Change-Id: Iaadea6b2aabda2b803e1053b6d6195ad186d2e5c
2026-04-04services: Add gardenhostd-service-type.Noé Lopez
* gnu/services/desktop.scm (gardenhostd-service-type) (gardenhostd-configuration): New variables. * doc/guix.texi (Desktop Services): Document it. Change-Id: Ied926c34b620cc8032a0b121c7419644746e2ce9 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2026-04-02doc: Version Control Services: Fix Fossil example.Nguyễn Gia Phong
In the Fossil service example, correct the field name for list-repositories? and set https? to #t. * doc/guix.texi (Version Control Services): Fix the example for fossil-service-type. Change-Id: Ib1c1ba57d8f438a51e8bb7b6e97c57785685e110 Reviewed-by: Noé Lopez <noelopez@free.fr>
2026-04-02services: cat-avatar-generator: Fix default cache directory.Evgeny Pisemsky
* gnu/services/web.scm (cat-avatar-generator-service): Append slash to default cache directory. * doc/guix.texi (PHP-FPM)<cat-avatar-generator-service>: Likewise. Mention requirements. Change-Id: Idd46deca135bf37133b46bee3ba535d9bedf9258 Merges: https://codeberg.org/guix/guix/pulls/5189 Reviewed-by: Yan Abu Arab <yanabuarab@gmail.com> Signed-off-by: Nguyễn Gia Phong <cnx@loang.net>
2026-03-29gnu: Add home-jellyfin-mpv-shim-service-type.Ian Eure
* gnu/home/services/media.scm (home-jellyfin-mpv-shim-service-type): New variable. * doc/guix.texi (Jellyfin Services): New section. * doc/guix.texi (Kodi Services): Add subheading. Change-Id: I037ab0602214fdaa1b032be51ff98ecf6b7ee16c
2026-03-29gnu: Add collectd-service-type.Ian Eure
* gnu/services/monitoring.scm: (collectd-plugin-generic, collectd-plugin-generic?, collectd-plugin-generic-load-plugin?, collectd-plugin-generic-name, collectd-plugin-generic-options, collectd-plugin-python, collectd-plugin-python?, collectd-plugin-python-load-plugin?, collectd-plugin-python-type-databases, collectd-plugin-python-type-packages, collectd-plugin-python-module-paths, collectd-plugin-python-log-traces?, collectd-plugin-python-log-interactive?, collectd-plugin-python-import, collectd-plugin-python-module, collectd-plugin?, %collectd-default-type-database, %collectd-pid-file, collectd-configuration, collectd-configuration?, collectd-configuration-collectd, collectd-configuration-base-directory, collectd-configuration-auto-load-plugin?, collectd-configuration-collect-internal-stats?, collectd-configuration-type-databases, collectd-configuration-interval, collectd-configuration-max-read-interval, collectd-configuration-timeout, collectd-configuration-read-threads, collectd-configuration-write-threads, collectd-configuration-write-queue-limit-high, collectd-configuration-write-queue-limit-low, collectd-configuration-host-name, collectd-configuration-fully-qualified-domain-name-lookup?, collectd-configuration-plugins, collectd-service-type): New variable. * doc/guix.texi (Monitoring Services): Document it. Change-Id: I18d581292979e85603e679b9441be3eeb1856949
2026-03-29services: web: Add sogogi service.Sören Tempel
* gnu/services/web.scm (sogogi-service-type): New services. (sogogi-serialize-section, sogogi-serialize-field) (sogogi-serialize-string, sogogi-serialize-list-of-strings) (sogogi-serialize-sogogi-user, sogogi-serialize-sogogi-location) (sogogi-serialize-list-of-sogogi-user): New procedures. (sogogi-user, sogogi-location) (sogogi-configuration): New record types. (sogogi-account-service): New variable. (sogogi-config-file, sogogi-shepherd-service): New procedures. * gnu/tests/web.scm (%test-sogogi): Add tests for the service. * doc/guix.texi (Web Services): Document it. Change-Id: I5cc6dd84d6c7c8d5d13b685853b19c5d433ed7e5
2026-03-28doc: Document home-activation-service-type extension.Noé Lopez
* doc/guix.texi (Essential Home Services): Document home-activation-service-type extension. Merges: https://codeberg.org/guix/guix/pulls/7531 Change-Id: I2f27db86b138ab03ebca866b4a8be51c367b375c Reviewed-by: jgart <jgart@dismail.de> Signed-off-by: Sharlatan Hellseher <sharlatanus@gmail.com>
2026-03-25doc: Link to gexp research paper.Ludovic Courtès
* doc/guix.texi (G-Expressions): Add reference to the 2017 GPCE paper. Change-Id: I47f9357ee2715640e8ceb1f5d286d98bf6c55abc Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #7288
2026-03-25doc: Add ‘with-imported-modules’ caveat.Ludovic Courtès
* doc/guix.texi (G-Expressions): Document caveat under ‘with-imported-modules’. Change-Id: I9ee5452c7d776647961b282a0e6cefece165b00b Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-21gnu: home: services: Add home-git-annex-assistant-service-typeYarl Baudig
* gnu/home/services/git-annex-assistant.scm: New file. * gnu/local/mk (GNU_SYSTEM_MODULES): Register it. * doc/guix.texi (Miscellaneous Services): Document it. Change-Id: I9ca75210dfe7f6d2d81b9eb8919d6eb34c7bb002 Signed-off-by: Ian Eure <ian@retrospec.tv>
2026-03-20records: Let thunked fields refer to their inherited value.Ludovic Courtès
* guix/records.scm (make-syntactic-constructor)[field-index]: New procedure. [wrap-field-value]: Add optional argument ‘parent’. When it is true, bind F to the inherited field value. [field-bindings/inheritance]: New procedure. Use it. * tests/records.scm ("define-record-type* & thunked & no inherited value") ("define-record-type* & thunked & inherited value") ("define-record-type* & thunked & inherited value & this-record"): New tests. * doc/guix.texi (Defining Package Variants): Update ‘modify-inputs’ example to refer to ‘inputs’. (Writing Manifests): Likewise. * doc/guix-cookbook.texi (Package Variants): Likewise for ‘substitute-keyword-arguments’. Fixes: https://issues.guix.gnu.org/50335 Change-Id: If4e18155ce203637ff9e116ee8098f8997bfebe2
2026-03-19services: dbus: Add rtkit service.陈功
* gnu/services/dbus.scm (rtkit-service-type): New variable. (rtkit-configuration): New record. Change-Id: I5078cb5032824c7799e7d26962911bbc67527562 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2026-03-18doc: Fix %childhurd-os example and memory-size documentation.Hugo Buddelmeijer
* doc/guix.texi (Virtualization Services): Fix %childhurd-os example and memory-size documentation. Change-Id: I5537eda4d0181e88229d836db522775494fc3d69 Signed-off-by: Maxim Cournoyer <maxim@guixotic.coop>
2026-03-14doc: Reintroduce mention of ‘bug-reference-mode’.Ludovic Courtès
* doc/contributing.texi (Emacs): Add @unnumberedsubsubsec commands. Add “Referencing Bug Reports” section. Change-Id: I21d7ecc022c00fc4d4cecf2273b1d46d8e770195 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #6614
2026-03-14doc: Document Emacs-Guix for development.Ludovic Courtès
* doc/contributing.texi (Emacs): Document Emacs-Guix. Change-Id: I921f77425706709e49094ee96b28e29e29ad6878 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-14doc: Add references to “The Perfect Setup”.Ludovic Courtès
* doc/guix.texi (Defining Packages, Using the Configuration System): Add cross reference to “The Perfect Setup”. * doc/guix-cookbook.texi (A Scheme Crash Course): Likewise. Change-Id: If62960ffc01aadf9143b3816f4702f30b8052b90 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-14doc: Move “Guile Studio” and “Vim and NeoVim” under “The Perfect ↵Ludovic Courtès
Setup”. * doc/contributing.texi (The Perfect Setup): Add introduction. Move former body to … (Emacs): … this. (Alternative Setups): Remove. (Guile Studio, Vim and NeoVim): Move under “The Perfect Setup”. Change judgmental sentence. Change-Id: I149d418ac17a2283ad3452213b7425be4a8893f4 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-14doc: Remove “Viewing Bugs within Emacs”.Ludovic Courtès
This is a followup to d499253d47cca2694944c5fd1f4b582e5206890a and related commits. * doc/contributing.texi (Viewing Bugs within Emacs): Remove. (Debbugs User Interfaces): Refer to the ‘debbugs-ug’ manual. Change-Id: Idddff940302efe5689c8b459e0b141acaae74395 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-14doc, gnu: Update URL of several packages formerly at notabug.org.Ludovic Courtès
The URL change for these 5 packages was announced at <https://lists.gnu.org/archive/html/guile-user/2026-03/msg00000.html>. * doc/contributing.texi (Requirements): Update URLs. * gnu/packages/gnupg.scm (guile-gcrypt)[home-page]: Update. * gnu/packages/guile.scm (guile-sqlite3)[home-page]: Update. (guile-zlib)[source]: Update URL and hash. [home-page]: Update. (guile-lzlib)[home-page]: Update. (guile-zstd)[home-page]: Update. * m4/guix.m4 (GUIX_CHECK_GUILE_SQLITE3): Update commit URL. Merges guix/guix!7069 Change-Id: Ic587d3e2dcd931a44c007d9cdcd0b20e771be33b Signed-off-by: Cayetano Santos <csantosb@inventati.org>
2026-03-11doc: Version Control Services: Generalize introduction.Nguyễn Gia Phong
* doc/guix.texi (Version Control Services): Update description to not be Git-exclusive. Update instroduction to mention Fossil in addition to Git. Add anchor points to navigate to individual services from the introduction. Change-Id: I3af870a80fcf249bed97b0d29370f71ff00a9e73 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #4354
2026-03-11services: Add fossil-service-type.Nguyễn Gia Phong
* gnu/services/version-control.scm (fossil-service-type, fossil-configuration): New public variables. * gnu/tests/version-control.scm (%test-fossil): Add system tests. * doc/guix.texi (Version Control Services): Add Fossil documentation. Change-Id: I84e09fe8c11e161ed7c4bdba42b0ae38ef4c2096 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-03-11services: Add and use shepherd-signal-action.Yelninei
* gnu/services/shepherd.scm (shepherd-signal-action): New procedure. * gnu/services/audio.scm (mpd-shepherd-service): Use it for actions. * gnu/services/base.scm (syslog-shepherd-service): * gnu/services/base.scm (dnsmasq-shepherd-service): * gnu/services/file-sharing.scm (transmission-daemon-shepherd-service): * gnu/services/monitoring.scm (vnstat-shepherd-service): * gnu/services/mail.scm (rspamd-shepherd-service): * doc/guix.texi (shepherd-signal-action): Document it. Change-Id: Ief5e00c7d430ec4aa28c3ef11d0ef9897793b45f Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #6097
2026-03-10services: Generalize alsa-configuration.Liliana Marie Prikler
* gnu/packages/sound.scm (alsa-pcm-configuration, alsa-ctl-configuration): New configuration records. (serialize-alsa-pcm-configuration, serialize-alsa-ctl-configuration): New variables. (<alsa-configuration>): Remove alsa-plugins and pulseaudio?. Add default-pcm and default-ctl. Rename extra-options to options. (alsa-config-file): Adjust accordingly. (alsa-servcice-type): Add compose and extend. (<pulseaudio-configuration>): Add alsa-lib. (pulseaudio-alsa-configuration): New procedure. (pulseaudio-service-type): Extend alsa-servcice-type.
2026-03-09gnu: Add soju-service-type.Giacomo Leidi
* gnu/services/messaging.scm (%default-soju-shepherd-requirement): New variable. (soju-ssl-certificate): New configuration record. (soju-database): New configuration record. (soju-configuration): New configuration record. (serialize-soju-configuration,soju-activation,soju-accounts, soju-shepherd-services): New procedures. (soju-service-type): New service. (serialize-ngircd-configuration): Reformat. (pounce-configuration): Reformat. * doc/guix.texi: Document the new soju service. * gnu/tests/messaging.scm: Test the new soju service. Change-Id: I6223ecac1aaaab76bd75461851ffe4cec0678118
2026-03-08doc: Remove mention of python-toolchain.Sharlatan Hellseher
* doc/contributing.texi (Python Moduels): Drop mention of python-toolchain. * guix/build-system/pyproject.scm: Likewise. Fixes: guix/guix#5841 Change-Id: I39a1ec7ce6da2e5f3298323b36070c3e3b197669
2026-03-07gnu: home: dotfiles: Fix inclusion of directories having .git in their name.Giacomo Leidi
* gnu/home/services/dotfiles.scm (%home-dotfiles-excluded): Replace .git/.* with /.git/.* . * doc/guix.texi: Document it. Fixes https://codeberg.org/guix/guix/issues/6808 Change-Id: Ib6c824bb4bf5a5b3d6939807667c7961ce0cf6d2
2026-03-07gnu: Add tuned-service-type.Giacomo Leidi
* gnu/services/linux.scm (tuned-configuration,tuned-settings,tuned-ppd-settings): New configuration records. (tuned-file-systems,tuned-activation,tuned-shepherd-services, tuned-kernel-modules): New procedures. (tuned-service-type): New service type. * doc/guix.texi: Add service documentation. Change-Id: I6c8d54c23175c2ea133d99965641c548fb1d6452