summaryrefslogtreecommitdiff
path: root/doc/guix-cookbook.texi
AgeCommit message (Collapse)AuthorFilesLines
2026-07-11doc: Fix typos.Julien Lepiller1-8/+8
* doc/guix-cookbook.texi: Fix typos. * doc/guix.texi: Fix typos. Co-Authored-By: Konstantin Suntsov <protvin@disroot.org> Change-Id: I251274b29683d9ce5b89189a303d7ee7bf6a4638
2026-07-11doc: Add TRANSLATORS comment.Julien Lepiller1-0/+5
* doc/guix.texi: Add comment in headers to help translators. * doc/guix-cookbook.texi: idem. Change-Id: I84d56a47deb0cab442d4b638908736d44303bfa1
2026-07-11doc: cookbook: Improve style in section about updating rust packageswrobell1-2/+2
* doc/guix-cookbook.texi (Common Workflow for Updating Existing Rust Packages): Improve style by dropping double "now" and "following" words. Change-Id: I7426920dcd1717ccb410059bd3634b2b3fd48cc1 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #9802
2026-07-04nls: Update translations.Florian Pelz1-3/+2
* po/doc/guix-cookbook.ta.po: Delete file, as it is based on clearly low-quality machine translation. * po/doc/local.mk: Remove 'ta' cookbook. * po/doc/po4a.cfg (po4a_langs): Remove 'ta'. * doc/local.mk: Remove 'ta' cookbook. * doc/htmlxref.cnf: Update URLs for cookbook. * doc/build.scm (%cookbook-languages): Remove 'ta'. (html-manual-indexes)<language-index>: Do not hide PDF for 'ta'. * doc/guix-cookbook.texi (Top): Do not mention 'ta' cookbook.$
2026-07-03doc: cookbook: Fix shell instructions on updating rust packages.Cayetano Santos1-2/+2
* doc/guix-cookbook.texi (Common Workflow for Updating Existing Rust Packages): Add missing packages. Merges guix/guix!9496
2026-07-01cookbook: Update subtitle.Gabriel Wicki1-1/+1
GNU Guix has grown to be much more than a "Functional Package Manager". This change reflects that fact. * doc/guix-cookbook.texi (@subtitle): Update it. Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-07-01cookbook: Add gabber to copyright lines.Gabriel Wicki1-0/+1
* doc/guix-cookbook.texi: Add myself to copyright lines. Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-07-01cookbook: Fix order of copyright holders.Gabriel Wicki1-2/+2
* doc/guix-cookbook.texi: Order copyright notices by year. Signed-off-by: Gabriel Wicki <gabriel@erlikon.ch>
2026-06-18doc: Recommend dhcpcd-service-type instead of dhcp-client-service-typeSören Tempel1-1/+1
* doc/guix-cookbook.texi (Running Guix on a Linode Server): Use dhcpcd-service-type in the example. * doc/guix.texi (Running Guix in a VM): Replace mention of dhcp-client-service-type with dhcpcd-service-type. (Networking Setup): Mention dhcpcd-service-type when explaining IWD. (Web Services): Use dhcpcd-service-type in PHP with nginx example. Change-Id: I4e985a9a667b4f6fd76156fb992ea959bae39b93 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2026-06-03doc: cookbook: Add new prepare-rust-crates phase.Gábor Udvari1-1/+2
* doc/guix-cookbook.texi (Using Rust Libraries in Other Build Systems): Add new prepare-rust-crates phase introduced in commit 3691bb640d33150d2ff3f8194e6f157325a8d5e4. Change-Id: I98ca9757d32db73ce94048a0c9f08ce2288bffb0 Signed-off-by: Efraim Flashner <efraim@flashner.co.il>
2026-05-17doc: cookbook: More cross-reference fixes under “Packaging Tutorial”.Ludovic Courtès1-3/+6
* doc/guix-cookbook.texi (Recursive importers): Turn @pxref into @xref to avoid repetition. (Automatic update): Add cross-reference to “Invoking guix refresh”. Change-Id: I7511c539209ee1d861270dfe520c3f4930449d4e Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-05-17doc: cookbook: Fix typo.Ludovic Courtès1-1/+1
The typo was introduced in 2cbe77f480fa74f74ef4bd6c7a1606e3f08bb142. * doc/guix-cookbook.texi (Inheritance): Fix typo. Change-Id: I09616d4336ab827ae298e331be7a9117a0b9214c Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2026-05-11doc: cookbook: Add links from “Packaging Tutorial” to the manual.Ludovic Courtès1-11/+26
* doc/guix-cookbook.texi (A ``Hello World'' package): Add link to “origin Reference” and adjust markup. (Extended example): Link to “origin Reference”. Fix markup. Link to “Packages with Multiple Outputs”, “Build Systems”, “Build Phases”, and “G-Expressions”. Adjust reference to the Guile manual. (Inheritance): Link to “Defining Package Variants”. (References): Use @xref to reference the manual. Change-Id: Ifa605adc1c91f2735b66005c8a7412f60cdb4484 Signed-off-by: Ludovic Courtès <ludo@gnu.org> Merges: #8392
2026-05-01doc: cookbook: Fix qemu network bridge example.宋文武1-4/+4
* doc/guix-cookbook.texi (Virtual Machines) [Network bridge for QEMU]: Enable 'autoconnect' for the 'bridge-slave-enp2s0' connection. Fix 'bridge.conf' example. Add missing 'helper' argument to the qemu invocation. Change-Id: I94fdb69b65cb032cfc9f21ae1dfab950937f1a70
2026-04-29docs: Update release signing key.Rutherther1-3/+3
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-23doc: Add a note reminder to checkout the correct tag for rust crates.Murilo1-0/+9
* 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.Murilo1-0/+217
* 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: Add new workflow for resolving merge conflicts on rust crate PRs.Murilo1-0/+97
* 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-03-20records: Let thunked fields refer to their inherited value.Ludovic Courtès1-1/+1
* 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ès1-0/+3
* 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ès1-4/+17
* 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ès1-7/+13
* 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ès1-4/+12
* 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 Chain1-2/+2
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 Chain1-4/+4
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ès1-4/+0
* 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 Pelz1-2/+3
* 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 Pelz1-1/+1
* 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 Pelz1-1/+1
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 Hinsen1-3/+3
* 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ès1-2/+2
* 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ès1-1/+252
* doc/guix-cookbook.texi (Reproducible Research): New node. Change-Id: I73d12771a2c2b5717b8f553dacae272f509a9fed
2025-10-08doc: cookbook: Fix network bridge qemu example.Gabriel Wicki1-1/+2
* 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 Pelz1-1/+2
* 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 Chain1-0/+377
* 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 Pelz1-0/+1
* 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 Pelz1-3/+3
See <https://bugs.gnu.org/78319>. * doc/guix-cookbook.texi (Packaging Tutorial): Fix links. Change-Id: Ib13b77a8248f6a1b91c05079c457bc4e96d847f3
2025-07-09doc: Update weblate URL.Julien Lepiller1-1/+1
* 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 Quandour1-3/+3
* 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ès1-2/+2
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 Abramov1-2/+2
* 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 Pelz1-0/+1
* 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 Hogan1-0/+1
* doc/guix-cookbook.texi (Extended example): Include missing module. Change-Id: Ibbda03344ad8762ea0c775a7eac36036c3b6200a
2025-04-06doc: cookbook: Update instructions for building a custom kernel.Adam Quandour1-31/+16
* 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.45mg1-0/+131
* 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.45mg1-8/+13
* 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.45mg1-11/+12
* 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 Cournoyer1-2/+2
Change-Id: I435d799ac458c38894f06b94d4334f0854a2c219
2025-02-28nls: Update translations.Florian Pelz1-3/+4
* 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 Flashner1-1/+1
Change-Id: I567aec7b1fac91234f46886c35affa6bd6e582d9