aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2024-06-13services: dnsmasq: Add escape hatch.Sergey Trofimov
* gnu/service/dns.scm: (<dnsmasq-configuration>)[extra-options]: Add. * doc/guix.texi: Document (<dnsmasq-configuration>)[extra-options]. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I7d2df7aa5d3b041b69b2f8b3e311a7328c28a3be
2024-06-13doc: Use a symbol for Cuirass specification names.Ludovic Courtès
* doc/guix.texi (Continuous Integration): Change ‘name’ field of ‘specification’ to be a symbol, as written in upstream Cuirass doc. Change-Id: I0a8cddfb8ab47f627a01459393aaf346028bb3f6
2024-06-12doc: Refer to mumi send-email in Submitting Patches.Arun Isaac
* doc/contributing.texi (Submitting Patches): Refer to mumi send-email. Change-Id: I009cdc306220ef63e6641fac69d3453ab169bfa2
2024-06-12doc: Add mumi CLI concept index entries.Arun Isaac
* doc/contributing.texi (Debbugs User Interfaces)[Command-line interface]: Add mumi CLI concept index entries. Change-Id: Ic2e67226c18e87a7360b938476a662aae76dd58e
2024-06-12doc: Document mumi am, compose and www subcommands.Arun Isaac
* doc/contributing.texi (Debbugs User Interfaces)[Command-line interface]: Document mumi am, compose and www subcommands. * doc/guix.texi: Bump copyright year. Change-Id: I28bde9454ad35115ed60fe4d6ffa35fad599b2d1
2024-06-12doc: Update field name in gitile-configuration.Nguyễn Gia Phong
* doc/guix.texi (gitile-configuration): Update field name nginx-server-block to nginx. Change-Id: I215d3d57c1cb88271c580fa1426a661477a775f7 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-06-06doc: Binary Installation: Add Parabola packages.Denis 'GNUtoo' Carikli
* doc/guix.texi (Binary Installation): Add Parabola packages. Co-authored by: Florian Pelz <pelzflorian@pelzflorian.de> Change-Id: Id646152c54de0a958740314b09fdcf6af898e22e Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
2024-06-06doc: Binary Installation: Mention Trisquel package.Denis 'GNUtoo' Carikli
* doc/guix.texi (Binary Installation): Also mention Trisquel package. Change-Id: Iae6f77de43de2c6f387b99a10dcae5b9d82aaee1 Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
2024-06-06doc: Advise system administrators to read and follow security notices.Florian Pelz
* doc/guix.texi (Binary Installation): Prefix installation instructions with the advice. Change-Id: I088c7f00f4c3c8e32bdfd117ea934942930f7513
2024-06-04services: base: Add optional delayed mount of file-systemsRichard Sent
Add a mechanism to only require mounting a subset of file-system entries during early Shepherd initialization. Any file-system with additional Shepherd service requirements (e.g. networking) is not required to provision 'file-systems. * gnu/services/base.scm (file-system-shepherd-service): Splice file-system-requirements into the Shepherd service requirement list. (file-system-shepherd-services): Provision 'file-system only when file system services without additional Shepherd requirements are started. * gnu/system/file-systems.scm (file-system): Add shepherd-requirements field to the file-system record. This field is used for adding additional Shepherd requirements to a file-system Shepherd service. * doc/guix.texi: Add documentation for file-system shepherd-requirements. Change-Id: If0392db03d48e8820aa53df1df482c12ec72e1a5 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
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-03build: Use the po4a command for the translation generation.gemmaro
* configure.ac (Documentation translation): Remove the po4a-translate command. This command has been replaced by the po4a command and are not used from anywhere. * doc/local.mk ($(srcdir)/%D%/guix.%.texi, $(srcdir)/%D%/guix-cookbook.%.texi) ($(srcdir)/%D%/contributing.%.texi): Use the po4a command instead of the po4a-translate for the translation generation. This eliminates the warning of po4a-translate; "po4a-translate is deprecated. The unified po4a(1) program is more convenient and less error prone." (PO4A_PARAMS): Remove the Texinfo format option. This option is specified in the configuration file (po/doc/po4a.cfg). (dummy_pot): Add a variable for the temporary POT file location. Change-Id: I542b934c3c03b8701e9f86823191224f8b0ccf81 Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
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-06-02services: nscd: ‘log-file’ defaults to #f.Ludovic Courtès
* gnu/services/base.scm (<nscd-configuration>)[log-file]: Default to #f. * doc/guix.texi (Base Services): Clarify documentation. Change-Id: Ia75914fc2665db13bef688d53659083a615ebef4
2024-06-02Revert "services: home: Use pairs instead of lists."Andrew Tropin
This reverts commit dbeef44f3c520816251bde74c1005915a637e1ef. Despite the more semantically correct data type, it doesn't follow the style of the most services and also breaks user-facing API. Change-Id: Ib4ef4e9cd2f53ac853a5b7c7c90e57c35c99a5ea
2024-06-02services: home: Use pairs instead of lists.Andrew Tropin
* gnu/services/guix.scm: Use pairs instead of lists. * doc/guix.texi: Update accordingly. * gnu/tests/guix.scm: Update accordingly. Change-Id: I0b8d3fa5b214add89bdb84a11fa20d1b319435f0
2024-05-30home: services: Add home-startx-command-service-type.Tomas Volf
* gnu/home/services/desktop.scm (home-startx-command-service-type): New variable. (startx-command-service-type): New service-type mapping. * doc/guix.texi (Guix Home Services): Document home-startx-command-service-type. Change-Id: Id38b5dc7b9235e04e3a9a1b70a35b02e8fae95f0 Signed-off-by: Arun Isaac <arunisaac@systemreboot.net>
2024-05-30services: xorg: Add startx-command-service-type.Tomas Volf
* gnu/services/xorg.scm (startx-command-profile-service, startx-command-service-type): New variables. * doc/guix.texi (X Window): Document startx-command-service-type. Change-Id: Ia2a7c3b2d5ebf6bcfff40cb2640b17d3baf6eba0 Signed-off-by: Arun Isaac <arunisaac@systemreboot.net>
2024-05-30services: xorg: Add xorg-start-command-xinit procedure.Tomas Volf
When the user does not use any desktop environment, the typical sequence is to log in and then type `startx' into the tty to get a window manager running. Most distributions do provide a startx by default, but Guix has only an xorg-start-command that is not suitable for this. This commit adds a second procedure, xorg-start-command-xinit, that correctly picks a virtual terminal to use, sets up XAUTHORITY and starts xinit with the correct arguments. That should make running Guix without a desktop environment more approachable. * gnu/services/xorg.scm (xorg-start-command-xinit): New public procedure. * doc/guix.texi (X Window): Document it. Change-Id: I17cb16093d16a5c6550b1766754700d4fe014ae9 Signed-off-by: Arun Isaac <arunisaac@systemreboot.net>
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-27gnu: Use new ovmf firmware packages.Efraim Flashner
* doc/guix.texi (Invoking guix system): Update qemu command to use ovmf-x86-64. * gnu/packages/virtualization.scm (xen)[inputs]: Replace ovmf with ovmf-i686. * gnu/tests/install.scm (uefi-firmware): Use system appropriate ovmf firmware. Change-Id: Ia2ff76eaf766c8d4fb0be4a7cc7b8941574433d0
2024-05-27doc: Replace 'specification->package+output' with 'specifications->packages'.宋文武
'(map specification->package+output specs)' doesn't work due to 'specification->package+output' will return multiple values. * doc/guix.texi (Using the Configuration System): Replace 'specification->package+output' with 'specifications->packages'. Change-Id: I443771327a2ef5ae5e7dddd9785f1eef4200e898
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-25maint: Suggest ‘guix git authenticate’ for initial authentication.Ludovic Courtès
The previous recommendation, running ‘make authenticate’, was insecure because it led users to run code from the very repository they want to authenticate: https://lists.gnu.org/archive/html/guix-devel/2024-04/msg00252.html * Makefile.am (commit_v1_0_0, channel_intro_commit) (channel_intro_signer, GUIX_GIT_KEYRING, authenticate): Remove. * Makefile.am (.git/hooks/%): New target, generalization of previous ‘.git/hooks/pre-push’ target. (nodist_noinst_DATA): Add ‘.git/hooks/post-merge’. * doc/contributing.texi (Building from Git): Suggest ‘guix git authenticate’ instead of ‘make authenticate’. * etc/git/post-merge: New file. * etc/git/pre-push: Run ‘guix git authenticate’ instead of ‘make authenticate’. Reviewed-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Reported-by: Skyler Ferris <skyvine@protonmail.com> Change-Id: Ia415aa8375013d0dd095e891116f6ce841d93efd
2024-05-25doc: Document ‘assume-valid-file-name’ in ‘local-file’.Richard Sent
* doc/guix.texi (G-Expressions): Document the use of assume-valid-file-name with local-file. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I132f78e198cbf3ba2e5a677d671563d753de534c
2024-05-25gnu: docker: Allow passing tarballs for images in oci-container-configuration.Giacomo Leidi
This commit allows for loading an OCI image tarball before running an OCI backed Shepherd service. It does so by adding a one shot Shepherd service to the dependencies of the OCI backed service that at boot runs docker load on the tarball. * gnu/services/docker.scm (oci-image): New record; (lower-oci-image): new variable, lower it; (string-or-oci-image?): sanitize it; (oci-container-configuration)[image]: allow also for oci-image records; (oci-container-shepherd-service): use it; (%oci-image-loader): new variable. Change-Id: Ie504f479ea0d47f74b0ec5df9085673ffd3f639d Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-25gnu: docker: Allow setting Shepherd dependencies in oci-container-configuration.Giacomo Leidi
* gnu/services/docker.scm (oci-container-configuration) [requirement]: New field; (list-of-symbols): sanitize it; (oci-container-shepherd-service): use it. * doc/guix.texi: Document it. Change-Id: Ic0ba336a2257d6ef7c658cfc6cd630116661f581 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-25gnu: docker: Allow setting host environment variables in ↵Giacomo Leidi
oci-container-configuration. * gnu/services/docker.scm (oci-container-configuration) [host-environment]: New field; (oci-sanitize-host-environment): sanitize it; (oci-container-shepherd-service): use it. * doc/guix.texi: Document it. Change-Id: I4d54d37736cf09f042a71cb0b6e673abc0948d9c Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-25gnu: docker: Provide escape hatch in oci-container-configuration.Giacomo Leidi
* gnu/services/docker.scm (exports): Add missing procedures; (oci-container-service-type)[description]: Docker and OCI images should mean the same thing; (oci-container-configuration): clarify field types; [extra-arguments]: new field; (oci-sanitize-extra-arguments): sanitize it; (oci-container-shepherd-service): use it. * doc/guix.texi: Document it. Change-Id: I64e9d82c8ae538d59d1c482f23070a880156ddf7 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-25services: Add restic-backup service.Giacomo Leidi
* gnu/services/backup.scm: New file. * gnu/local.mk: Add this. * doc/guix.texi: Document this. Change-Id: I9efd5559bb445b484107a7c27c2d0a65ccad1e66 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-22doc: Make changes to the handling of branches.Christopher Baines
Require that you create a "Request to merge" issue when you create a branch, rather than when you wish to merge it. This should help avoid this step being missed. Also, add information on how to manage these branches: 1. Suggest creating the branch from patches, rather than having a stateful branch, since this should help to reduce complexity and avoid merges. 2. Require that branches don't have unnecessary changes, since this increases the risks of conflicts with other branches. 3. Suggest that the branch not be stateful, and it's just a combination of patches. 4. Suggest avoiding merges since these create a more complicated Git history. 5. Suggest that the branch be up to date before merging, as this helps avoid the combination of master plus the branch differing significantly from the branch alone. 6. Document how to manage branches without commit access. Finally, require that the branch be deleted once they're merged. This prepares for the branch being created again. * doc/contributing.texi (Managing Patches and Branches): Make changes to the handling of branches. Change-Id: Ib9419c6df94f485475bd6f147e82ea254e76cec2
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-05-19import: Add binary npm importer.Jelle Licht
* guix/scripts/import.scm: (importers): Add "npm-binary". * doc/guix.texi (Invoking guix import): Document npm-binary importer. * guix/import/npm-binary.scm: New file. * guix/scripts/import/npm-binary.scm: New file. * tests/npm-binary.scm: New file. * Makefile.am: Add them. Co-authored-by: Timothy Sample <samplet@ngyro.com> Co-authored-by: Lars-Dominik Braun <lars@6xq.net> Change-Id: I98a45068cf5b9c42790664cc743feaa7ac76f807
2024-05-15gnu: services: Add power-profiles-daemon-service-type.Dariqq
* gnu/services/pm.scm (power-profiles-configuration): New configuration. (power-profiles-daemon-shepherd-service): New procedure. (power-profiles-daemon-activation): New variable. (power-profiles-daemon-service-type): New procedure. * doc/guix.texi (Power Management Services): Document it. Change-Id: Ib035d993ed82eec2a43f3ba2b4c92f77e08a0fd7 Signed-off-by: Christopher Baines <mail@cbaines.net>
2024-05-13doc: Fix bug in hg-reference documentation.Tomas Volf
The field is called changeset, not revision. And the string does not have to be a number. * doc/guix.texi (origin Reference): Fix documentation for hg-reference. Change-Id: Ic622dfc7b44caf42d070cdab8e42808dd96e6d63 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-13doc: Document cvs-fetch and cvs-reference.Tomas Volf
For some reason, they were missing from the documentation. This commit adds them including an example of usage. * doc/guix.texi (origin Reference): Add cvs-fetch and cvs-reference. Change-Id: I6622a9f70e6d71ed31fbb3d2689df4a6946f8868 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-12doc: Update NixOS wiki url to the official wiki.Picnoir
nixos.wiki was created by a community member a long time ago. It turned out to be very useful to the community, it became an official service last month hosted on the NixOS.org domain name. To ease the long term maintainance among other things. See more details at https://github.com/NixOS/foundation/issues/113 * doc/guix.texi (Nix service): Change nixos.wiki to wiki.nixos.org. Change-Id: Ia95074fbfad494e8ceb5c2cdb3faab23f3604882 Signed-off-by: Christopher Baines <mail@cbaines.net>
2024-05-04services: cuirass: Remove use-substitutes? configuration option.Ahmad Draidi
As of Cuirass commit 9a1452ee021c9f773424961cfeef47ca0b7c5c5a, this option seems to be unused and kept for back compatibility there. * gnu/services/cuirass.scm (<cuirass-configuration>): Remove use-substitutes? field. (cuirass-shepherd-service): Remove the option. * doc/guix.texi (Continuous Integration): Remove option documentation. Change-Id: I933550ce76eecdf918b07891aa8212fd30a7c87e Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-04services: cuirass: Add new configuration options.Ahmad Draidi
* gnu/services/cuirass.scm (<cuirass-configuration>): Add ttl and threads fields. (cuirass-shepherd-service): Handle the new options. * doc/guix.texi (Continuous Integration): Document them. Change-Id: I4387fbd7bf6766f4a54801f35c7ed82ce4eb9645 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-04services: cuirass: Use separate extra options for cuirass web process.Ahmad Draidi
Currently, "extra-options" is passed to both "cuirass register" and "cuirass web" processes. This makes it impractical since the extra parameters have to be intended for and supported by both processes. * gnu/services/cuirass.scm (<cuirass-configuration>): Add a web-extra-options field. (cuirass-shepherd-service): Replace extra-options with web-extra-options for cuirass web. * doc/guix.texi (Continuous Integration): Document the changes. Change-Id: Iba79c559ea8267aaf8f25248f3d18ed7b352cb60 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-05-01git authenticate: Install pre-push and post-checkout hooks.Ludovic Courtès
* guix/scripts/git/authenticate.scm (install-hooks): New procedure. (guix-git-authenticate): Use it. * doc/guix.texi (Invoking guix git authenticate): Document it. Change-Id: I4464a33193186e85b476a12740e54412bd58429c
2024-05-01git authenticate: Record introduction and keyring in ‘.git/config’.Ludovic Courtès
* guix/scripts/git/authenticate.scm (%default-options): Remove ‘keyring-reference’. (config-value, configured-introduction, configured-keyring-reference) (configured?, record-configuration, current-branch): New procedures. (guix-git-authenticate)[missing-arguments]: New procedure. Use ‘configured-introduction’ when zero arguments are given. Use ‘configured-keyring-reference’ when ‘-k’ is not passed. Add call to ‘record-configuration’. * doc/guix.texi (Invoking guix git authenticate): Document it. Change-Id: I66e111a83f50407b52da71662629947f83a78bbc
2024-04-29linux-initrd: Further strip the static Guile.Ludovic Courtès
‘guile-static-initrd’ weighs in at 46 MiB, compared to 54 MiB for ‘guile-static-stripped’ (15% reduction). * gnu/packages/make-bootstrap.scm (make-guile-static-stripped): Add ‘directories-to-remove’ parameter and honor it. (%guile-static-initrd): New variable. * gnu/system/linux-initrd.scm (expression->initrd): Default to ‘%guile-static-initrd’. * doc/guix.texi (Initial RAM Disk): Adjust accordingly. Change-Id: I2baf06fed7a3698433e7c83b1d7726054a8c746e
2024-04-29services: Add gvfs-service-type.宋文武
* gnu/services/desktop.scm (gvfs-service-type): New variable. (gvfs-configuration, make-gvfs-configuration, gvfs-configuration?, gvfs-package): New procedures. (<gvfs-configuration>): New record. * doc/guix.texi (Desktop Services): Document it. Change-Id: I584819500e2ce7d2b14e57dac238a96e9888e75e
2024-04-26doc: contributing: Move localstatedir instructions.Florian Pelz
* doc/contributing.texi (Requirements): Move localstatedir ... (Building from Git): ... here. Change-Id: I860bb7a9e6aea12881469c667496364248293c31
2024-04-26doc: contributing: Suggest building from Git.Florian Pelz
* doc/contributing.texi (Requirements): Explain the purpose of this section. Refer regular contributors to Building from Git. Change-Id: I731af4ac8e78b053b96a3b683528964223ab740b
2024-04-23doc: Fix mentions of 'nss-certs'.Fabio Natali
* doc/guix.texi (Using the Configuration System): Fix mention of 'nss-certs' after the package has been added to '%default-packages' (see '65e8472a4b6fc6f66871ba0dad518b7d4c63595e'). * doc/guix.texi (Web Services): Fix mention of 'nss-certs' after the package has been added to '%default-packages' (see '65e8472a4b6fc6f66871ba0dad518b7d4c63595e'). Change-Id: Iecdecb8deb440cdea224f3e9e7ce54e89dd575a2 Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
2024-04-22doc: Fix typo.Matthew Trzcinski
* doc/guix.texi (Installing Guix in a VM): Change indefinite article. Signed-off-by: Florian Pelz <pelzflorian@pelzflorian.de>
2024-04-20doc: Correct the "guix shell --container" example.Rostislav Svoboda
* doc/guix.texi (Invoking @command{guix shell}): Add missing parameters to preserve and expose $XAUTHORITY. Adjust corresponding textual description. Change-Id: Ib99c81c107ff9784708ae807ec9b3ab93ad75603 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2024-04-20doc: Update gnome-desktop-configuration.Liliana Marie Prikler
* doc/guix.texi (gnome-desktop-configuration): Fill in missing fields. [gnome]: Talk about the deprecation.