summaryrefslogtreecommitdiff
path: root/doc/guix-cookbook.texi
AgeCommit message (Collapse)Author
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-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-01-26doc: cookbook: Don’t insist on mounting home directories on the head node.Ludovic Courtès
* doc/guix-cookbook.texi (Setting Up a Head Node): State that mounting home directories on the head node is “optional”. Change-Id: Id60b54d463f5422f71a71607cd71ed347a98865e Merges: #5890
2026-01-26doc: cookbook: Recommend systemd timer for ‘guix gc’.Ludovic Courtès
* doc/guix-cookbook.texi (Setting Up a Head Node): Give instructions for the systemd timer rather than ‘crontab’. Change-Id: I063ad0ea694500a67553d66d37ae354b9c078a65
2026-01-26doc: cookbook: Update for unprivileged guix-daemon execution.Ludovic Courtès
* doc/guix-cookbook.texi (Setting Up a Head Node): Add note about unprivileged guix-daemon. Remove ‘--build-users-group=guixbuild’ flag from ‘.service’ snippets. Mention “systemd timer” next to “crontab entry”. Change-Id: I72ac59d3ce8a5572dbeb8cb4c7764a8478f6e1ee
2026-01-18import: crate: Generate comments with ‘TODO REVIEW:’ prefix.Hilton Chain
This distinguishes them from manually added ones. When committing changes, these ‘TODO REVIEW’ comments should be addressed and removed first. If you're working with Rust packaging, please update your local Guix to this commit to apply the change. * guix/import/crate.scm (cargo-lock->expressions): Generate comments with ‘TODO REVIEW:’ prefix. * tests/import/crate.scm ("crate-lockfile-import"): Don't check the exact comment string. * doc/guix-cookbook.texi (Common Workflow for Rust Packaging), * gnu/packages/rust-crates.scm: Adjust accordingly. Change-Id: I76b914b49be46d04cc61b101b6bc9e31cadb7f07 Signed-off-by: Rutherther <rutherther@ditigal.xyz> Merges: #4567
2026-01-18gnu: rust-crates: Add ‘package:’ prefix for replaced crates.Hilton Chain
This avoids definitions like ‘(define rust-pipewire-0.8.0.fd3d8f7 rust-pipewire-0.8.0.fd3d8f7)’. * gnu/packages/rust-crates.scm: Import (gnu packages rust-sources) module with ‘package:’ prefix. * etc/teams/rust/rust-crates.tmpl, * doc/guix-cookbook.texi (Cargo Workspaces and Development Snapshots): Adjust accordingly. Change-Id: Ie41556d8f30db65e968d8e8238491f1345eeed59 Signed-off-by: Rutherther <rutherther@ditigal.xyz>
2025-12-08doc: Remove unreachable reference from the Cookbook.Ludovic Courtès
* doc/guix-cookbook.texi (A Scheme Crash Course): Remove “Scheme at a Glance”, which is no longer accessible. Change-Id: Ia60bf461d0410ddd042b0ad7d792548749c4cc7c Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2025-12-01nls: Update translations.Florian Pelz
* po/doc/guix-cookbook.ta.po: New file. * po/doc/local.mk: Add 'ta' cookbook. * po/doc/po4a.cfg (po4a_langs): Add 'ta'. * po/guix/pt.po: New file. * po/guix/LINGUAS: Add 'pt'. * po/packages/ta.po: New file. * po/packages/LINGUAS: Add 'ta'. * doc/local.mk: Add 'ta' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'ta'. (html-manual-indexes)<language-index>: Hide PDF for 'ta'. * doc/guix-cookbook.texi (Top): Mention 'ta' cookbook. Change-Id: I05e887f31b0715def25ce1b1912077144ae65e92
2025-12-01doc: cookbook: Fix typo.Florian Pelz
* doc/guix-cookbook.texi (A Scheme Crash Course): Change supposed printout of code example to what is actually printed. Change-Id: I4d2d2f1f1c3be0a8251f2fc91bc5657bc63891c8
2025-10-20doc: cookbook: Update command for installing the SICP book.Florian Pelz
Follow-up to commit e5a5b1d66aa3a6d54b28c91f83ea2986ac84fcc6. * doc/guix-cookbook.texi (A Scheme Crash Course): Change command. Change-Id: Ie559fc88738abef0dfa75dfc1d5dc926a618e4c2
2025-10-19doc: cookbook: Minor correction to "Reproducible Research" chapter.Konrad Hinsen
* doc/guix-cookbook.texi (Setting Up the Environment): Reword. Change-Id: Ifaf8b3231fe1b3007dbaaf7005c249fbcdf1deb2 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2025-10-17doc: cookbook: Fix typos under “Reproducible Research”.Ludovic Courtès
* doc/guix-cookbook.texi (Setting Up the Environment): Remove extra word; add missing word. Change-Id: I41ba29bd81fd6e8262d4112e57e1ff0cce439967
2025-10-13doc: cookbook: Add “Reproducible Research” chapter.Ludovic Courtès
* doc/guix-cookbook.texi (Reproducible Research): New node. Change-Id: I73d12771a2c2b5717b8f553dacae272f509a9fed
2025-10-08doc: cookbook: Fix network bridge qemu example.Gabriel Wicki
* doc/guix-cookbook.texi (Virtual Machines) [Configuring the QEMU bridge helper script]: Fix example. Change-Id: Ia735637ab71928176b33da495d528d1519d29cb9 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2025-09-02nls: Update translations.Florian Pelz
* po/doc/guix-cookbook.zh_CN.po: New file. * po/doc/local.mk: Add 'zh_CN' cookbook. * po/packages/ru.po: New file. * po/packages/LINGUAS: Add 'ru'. * doc/local.mk: Add 'zh_CN' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'zh_CN'. * doc/guix-cookbook.texi (Top): Mention 'zh_CN' cookbook. Change-Id: Ic15114f01ee826a72060eebcbf1baf3bf619284f
2025-08-21doc: Document lockfile importer based Rust packaging workflow.Hilton Chain
* doc/guix.texi (Build Systems) [cargo-build-system]: Add cross-reference for the term "Cargo workspaces". * doc/contributing.texi (Packaging Guidelines)[Rust Crates]: Update documentation. * doc/guix-cookbook.texi (Packaging)[Packaging Workflow]: New section. * gnu/packages/rust-crates.scm, * gnu/packages/rust-sources.scm: Stop mentioning guix-rust-registry for now, we may remove the repository if future merges are managed well. Change-Id: Ic0c6378cf5f5df97d6f8bdd040b486be62c7bddc
2025-07-10nls: Update translations.Florian Pelz
* po/doc/guix-cookbook.it.po: New file. * po/doc/guix-manual.it.po: New file. * po/doc/local.mk: Add 'it' manual, cookbook. * po/doc/po4a.cfg (po4a_langs): Add 'it'. * po/guix/el.po: New file. * po/guix/LINGUAS: Add 'el'. * doc/local.mk: Add 'it' manual, cookbook. * doc/htmlxref.cnf: Update URLs for manual, cookbook. * doc/build.scm (%cookbook-languages, %manual-languages): Add 'it'. * doc/guix.texi (Top): Mention 'it' manual. * doc/guix-cookbook.texi (Top): Mention 'it' cookbook. Change-Id: I46023fa4b2dbe9db5227292823b4df9e41c3cee0
2025-07-10doc: Replace www.gnu.org broken links.Florian Pelz
See <https://bugs.gnu.org/78319>. * doc/guix-cookbook.texi (Packaging Tutorial): Fix links. Change-Id: Ib13b77a8248f6a1b91c05079c457bc4e96d847f3
2025-07-09doc: Update weblate URL.Julien Lepiller
* doc/build.scm (stylized-html): Update URL from fedora to codeberg's Weblate. * doc/contributing.texi: idem. * doc/guix-cookbook.texi: idem. * doc/guix.texi: idem. Change-Id: I13729a73f94738c9c336a067058020549f2640d6
2025-06-02doc: cookbook: Fix grammar.Adam Quandour
* doc/guix-cookbook.texi (Customizing the Kernel): Fix grammar. Change-Id: I896536a6c9f06e2fb30f3da56e054a26bfd5d0af Signed-off-by: Hilton Chain <hako@ultrarare.space>
2025-05-23maint: Change main repository URL to git.guix.gnu.org.Ludovic Courtès
Throughout, replace “https://git.savannah.gnu.org/git/guix.git” by “https://git.guix.gnu.org/guix.git”. Change-Id: Ieb82464f92a806b85c79e629f952e68c39323740
2025-05-16services: dnsmasq: Add shepherd-provision and shepherd-requirement fields.Alexey Abramov
* gnu/services/dns.scm (<dnsmasq-configuration>)[provision]: Mark filed as deprecated with a warning. Set default to #f. [shepherd-provision]: Add new field for consistency with other services. [shepherd-requirement]: Add new field. (dnsmasq-shepherd-service): Use them. * doc/guix.texi: Document these changes. * doc/guix-cookbook.texi (Custom NAT-based network for libvirt): Update example to use 'shepherd-provision' instead of 'provision'. Change-Id: Icad4d9c4be5bf58368e8c416f1fdde1f9065557d Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2025-05-03nls: Update translations.Florian Pelz
* po/guix/kab.po: New file. * po/guix/LINGUAS: Add 'kab'. * po/doc/guix-cookbook.es.po: New file. * po/doc/local.mk: Add 'es' cookbook. * doc/local.mk: Add 'es' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'es'. * doc/guix-cookbook.texi (Top): Mention 'es' cookbook. Change-Id: I795563ee78c930248ff860a03d9ce970099429da
2025-04-29doc: cookbook: Fix extended example.Greg Hogan
* doc/guix-cookbook.texi (Extended example): Include missing module. Change-Id: Ibbda03344ad8762ea0c775a7eac36036c3b6200a
2025-04-06doc: cookbook: Update instructions for building a custom kernel.Adam Quandour
* doc/guix-cookbook.texi (Customizing the Kernel): Update. Change-Id: I4451f038219c73b685fa3e80e1b05c729d4bea35 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Modified-by: Ludovic Courtès <ludo@gnu.org>
2025-03-23doc: cookbook: Custom NAT-based libvirt networks.45mg
* doc/guix-cookbook.texi (Virtual Machines): [Custom NAT-based network for libvirt]: New section. [References]: New section. Change-Id: Ice79c5dc8183ec694ac8b846a5ec88cb98cac9ff Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2025-03-23doc: cookbook: Clarify virtual network switches.45mg
* doc/guix-cookbook.texi (Virtual Machines): [Routed network for libvirt] {Creating a virtual network switch}: Remove unnecessarily noncommital language ("a few components/configurations, such as..."). Correct 'TUN interface', as bridges are currently used. Add a link to the libvirt Wiki for more information. Change-Id: I6ffdeca8e4d32155c8cce547d4930bf1b0cb471b Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2025-03-23doc: cookbook: Fix terminology for libvirt virtual network switches.45mg
* doc/guix-cookbook.texi (Virtual Machines) [Routed network for libvirt]: Replace the term 'virtual bridge' with 'virtual network switch'. This is the term used by the libvirt Wiki to refer to the combined setup of a 'virtual bridge' network interface, dnsmasq instance bound to it, and firewall rules associated with it; 'bridge' is ambiguous because it is sometimes used with this meaning, and sometimes to refer specifically to the virtual network device called a 'bridge'. Change-Id: Ibd10fe76321eb61e9ca23d8124634d1108d4faad Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2025-03-23doc/cookbook: Update menus.Maxim Cournoyer
Change-Id: I435d799ac458c38894f06b94d4334f0854a2c219
2025-02-28nls: Update translations.Florian Pelz
* po/doc/guix-cookbook.ru.po: New file. * po/doc/local.mk: Add 'ru' cookbook. * doc/local.mk: Add 'ru' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'ru'. * doc/guix-cookbook.texi (Top): Mention 'ru' cookbook. Change-Id: I5d59db90e23facbacd2b7ebe4a0847d0c44eb709
2025-02-19doc: Fix some misspellings.Efraim Flashner
Change-Id: I567aec7b1fac91234f46886c35affa6bd6e582d9
2025-01-11doc: cookbook: Update "Build system arguments" section.Marco Rimoldi
* doc/guix-cookbook.texi (Build system arguments) Remove recommendation on phase return value. Ensure code examples can run and are up-to-date. Change-Id: I143babf79983751578d6d4e20b20195ea000656d Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2025-01-01doc: Fix markup.Florian Pelz
* doc/guix-cookbook.texi (Upgrade Postgres for Cuirass): Escape '@'. Change-Id: Ifb34a20d107721df0523c343259e598503c87afb
2024-12-12doc: cookbook: Document postgres upgrade for cuirass.Gabriel Wicki
* doc/guix-cookbook.texi(System Management): New chapter. [Upgrade Postgres for Cuirass] New node. Change-Id: I23aae16b1f50b6c40c56b78712dfd6eae3834761 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-10-31doc: Fix typos.Florian Pelz
* doc/guix.texi (Sway window manager): Fix typo. * doc/guix-cookbook.texi (Top): Rename Portuguese cookbook. Change-Id: I61569aa882862871d9bf02fa1a97f3f3b902b494
2024-10-31doc: Fix markup.Florian Pelz
* doc/contributing.texi (Source Tree Structure, Submitting Patches, Translating Guix): Write @command instead of @code when invoking guix. (Submitting Patches): Write @code instead of @command for a field name. * doc/guix-cookbook.texi (A ``Hello World'' package): Use @xref at the beginning of a sentence. (Auto-Login to a Specific TTY): Remove a space before @pxref. (Basic setup with manifests): Write @ref instead of (@pxref) after ``see''. Change-Id: I1ced2ebc4062b3a80878a7e0eea8f7a3d4baf7da
2024-09-09doc: cookbook: Fix typo in screen-locker-service-typeRoman Scherer
The screen locker service type is called screen-locker-service-type, and not screen-locker-services-type. * doc/guix-cookbook.texi (Xorg): Fix typo. Change-Id: I191b0cb971f435f283ff8d0278e581372d16ae95 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-08-18Replace some more occurrences of ‘setuid-programs’.Tobias Geerinckx-Rice
* gnu/packages/containers.scm (podman, buildah)[arguments]: Substitute /run/privileged/bin for /run/setuid-programs. * gnu/packages/mail.scm (opensmtpd)[arguments]: Likewise. * gnu/packages/spice.scm (spice-gtk)[arguments]: Likewise. * gnu/packages/patches/enlightenment-fix-setuid-path.patch: Likewise. * gnu/packages/xdisorg.scm (xsecurelock)[description]: Rewrite example code to use the ‘privileged-program(s)’ terminology. * doc/guix-cookbook.texi (Network bridge for QEMU): Likewise. * gnu/packages/disk.scm (udevil)[arguments]: Update a comment. Change-Id: I7f467e8743a3ef556cd89bac41509bf51d9edb30
2024-06-03nls: Update translations.Florian Pelz
* po/doc/guix-cookbook.sv.po: New file. * po/doc/local.mk: Add 'sv' cookbook. * po/doc/po4a.cfg (po4a_langs): Add 'sv'. * doc/local.mk: Add 'sv' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'sv'. * doc/guix-cookbook.texi (Top): Mention 'sv' cookbook. Change-Id: Ibfeb7254f583f1c8827e8c2756bbb02880bcba46
2024-06-03doc: cookbook: Fix direnv example.Florian Pelz
When replacing `guix environment' with `guix shell', I forgot to add a `--development' argument. Follow-up to 9c3a8a380bcfebdb77af61532e7bfec523d7bde8. * doc/guix-cookbook.texi (Environment management) [Guix environment via direnv]: Fix example. Change-Id: I0a0df33b3b547bfc3ada10c4648e593be6608070
2024-05-29gnu: linux: Turn %default-extra-linux-options into a procedure.Maxim Cournoyer
This is to allow version-specific options to the list of defaults. * gnu/packages/linux.scm (%default-extra-linux-options): Transform to... (default-extra-linux-options): ... this procedure, which accepts a 'version' argument. (make-linux-libre, linux-libre-arm-generic, linux-libre-arm-generic-5.10) (linux-libre-arm-generic-5.4, linux-libre-arm64-generic) (linux-libre-arm64-generic-5.10, linux-libre-arm64-generic-5.4) (linux-libre-riscv64-generic, linux-libre-mips64el-fuloong2e) (linux-libre-with-bpf): Adjust accordingly. * doc/guix-cookbook.texi (Customizing the Kernel): Adjust accordingly. Change-Id: Ifd3be8b7ed8699bada224a938dbc84205366ff3d
2024-05-25configure.ac: Set default value for the 'prefix' variable.Maxim Cournoyer
The Guix standard configuration uses a localstatedir of /var and a sysconfdir of /etc. To ease things for everyone, make the default values match that standard expected configuration. See <https://lists.gnu.org/archive/html/guix-devel/2024-05/msg00003.html> for a related discussion. * configure.ac: Default $prefix to '' unless already set. * doc/contributing.texi (Building from Git): Streamline doc. * doc/guix-cookbook.texi (Guix environment via direnv): Likewise. Reviewed-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I23cd12b58a842d246fbc9fdc740311c573eb0212
2024-05-19doc: cookbook: Fix overlong lines.Florian Pelz
Fixes <https://issues.guix.gnu.org/63680>. Thanks to Nigko Yerden for telling me ExecStart lines can be multi-line <https://lists.gnu.org/archive/html/bug-guix/2024-05/msg00153.html>. * doc/guix-cookbook.texi (System Configuration) [Customizing the Kernel]: Split lines. [Customizing a Window Manager]<StumpWM>: Likewise. [Setting up a bind mount]: Move comments. [Getting substitutes from Tor]: Split line with backslash. [Music Server with Bluetooth Audio]: Likewise. (Advanced package management)[Guix Profiles in Practice] <Basic setup with manifests>: Likewise. <Reproducible profiles>: Likewise. (Environment management)[Guix environment via direnv]: Likewise. (Installing Guix on a Cluster)[Setting Up a Head Node]: On Info and PDF, split ExecStart= command with backslash. Change-Id: I31ef5b0417b319c3f6946d65f83edafb86c8f36b
2024-04-18system: Remove nss-certs from OS templates, adjust doc.Maxim Cournoyer
This is a follow-up to commit 86afaadb51 ("system: Add 'nss-certs' to %base-packages-networking.") * doc/guix-cookbook.texi (Running Guix on a Linode Server): Remove nss-certs from operating system's packages field. (Running Guix on a Kimsufi Server): Likewise. * doc/guix.texi (Using the Configuration System): Likewise. (X.509 Certificates): Adjust to mention nss-certs *is* part of %base-packages. * gnu/installer/services.scm (%system-services): Remove recommendation to install nss-certs. * gnu/system/examples/bare-bones.tmpl (host-name): Remove obsolete comments. * gnu/system/examples/desktop.tmpl (packages): Remove nss-certs. * gnu/system/examples/lightweight-desktop.tmpl (packages): Likewise. * gnu/system/examples/plasma.tmpl (packages): Likewise. * gnu/system/examples/raspberry-pi-64-nfs-root.tmpl (packages): Likewise. * gnu/system/examples/raspberry-pi-64.tmpl (packages): Likewise. * gnu/system/examples/vm-image.tmpl (packages): Likewise. * gnu/system/images/orangepi-r1-plus-lts-rk3328.scm (packages): Likewise. * gnu/system/images/pine64.scm (packages): Likewise. * gnu/system/install.scm (installation-os) [packages]: Likewise. Change-Id: If09123a69b987178bcb0aab61c4570c14fc1286f
2024-04-01nls: Update translations.Florian Pelz
* po/guix/ar.po: New file. * po/guix/LINGUAS: Add 'ar'. * po/doc/guix-cookbook.pt_BR.po: New file. * po/doc/local.mk: Add 'pt_BR' cookbook. * doc/local.mk: Add 'pt_BR' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Add 'ko', 'pt_BR'. * doc/guix-cookbook.texi (Top): Mention 'ko', 'pt_BR' cookbook. Change-Id: Id1846ca100263b3fc1fa2ed52654c670270ee809
2024-03-31doc: cookbook: Fix typo.Maxim Cournoyer
* doc/guix-cookbook.texi (Network bridge for QEMU): Fix typo. Change-Id: I32f88bd85157a6b2cee9f68840f9e77101596518
2024-03-19doc: cookbook: Account for ‘guix pull’ in /etc/profile instructions.Ludovic Courtès
* doc/guix-cookbook.texi (Setting Up Compute Nodes): Include $HOME/.config/guix/current. Change-Id: I6c1c42394991af8f1fa7c2630bdb4b0aef946c2b
2023-12-31doc: cookbook: Fix typo.Jonathan Brielmaier
Follow-up: f24b14767d362a84e6469682b4fe303b50f4b589 * doc/guix-cookbook.texi (Routed network for libvirt): Fix typo in section name. Change-Id: I1ba7ee2cba89764283f6a702a793ee9100585a87
2023-12-30Add network bridge guide to the cookbook.Maxim Cournoyer
Change-Id: If478196985aac7947067329957516f82bcb95ca4
generated by cgit v1.3 (git 2.53.0) at 2026-06-03 13:06:51 +0000