aboutsummaryrefslogtreecommitdiff
path: root/doc/guix.texi
AgeCommit message (Collapse)Author
2024-04-06doc: Move "Running the Test Suite" after "Building from Git".Matthew Trzcinski
* doc/contributing.texi (doc/guix.texi): Move "Running the Test Suite" after "Building from Git". Link: <https://lists.gnu.org/archive/html/guix-devel/2024-03/msg00023.html> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-04-06doc: Move "Requirements" before "Building from Git"Matthew Trzcinski
* doc/contributing.texi (doc/guix.texi): Move "Requirements" before "Building from Git". Link: <https://lists.gnu.org/archive/html/guix-devel/2024-03/msg00023.html> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-04-06doc: Fix Texinfo menus.Maxim Cournoyer
There should be two spaces between the node name and its description. Found via 'M-x texinfo-all-menus-update' in Emacs. Change-Id: I2b17180746f8d97ea5f927b8a504419c087dd5f5
2024-04-06doc: Simplify installation instructionsMatthew Trzcinski
* doc/guix.texi (Installation): - Move the definition of "foreign distro" out of quotation - Repeat overwrite warning - Remove superfluous commentary * doc/guix.texi (Binary Installation): - Clarify that installing on a foreign distro has two methods: using packaged binaries and building from source - Add cross reference to "Building from Git" - Move the foreign distro installation instructions out of quotation - Move directions for 'guix-install.sh' after instructions to use distribution-specific package managers - Specify "distributions" as "GNU/Linux distributions" - Add GnuPG as a requirement for 'guix-install.sh' - Add comma after "Likewise" - Remove redundant instructions to use 'guix-install.sh' - Split the requirements between system requirements for binary installations, GNU/Linux or GNU/Hurd, and requirements for running 'guix-install.sh' - Clarify that 'guix-install.sh' guides users through the steps - Summarize the steps 'guix-install.sh' follows rather than try to detail them - Make explicit that the 'guix-install.sh' default is to download substitutes - Emphasize that the substitute authorization code is an example and may need modification Link: <https://lists.gnu.org/archive/html/guix-devel/2024-03/msg00023.html> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2024-04-05gnu: guix: Define ‘guix-for-channels’ and document its use.Ludovic Courtès
* gnu/packages/package-management.scm (guix-for-channels): New procedure. * doc/guix.texi (Customizing the System-Wide Guix): New section. (Base Services): Add cross-reference. Change-Id: Ied51c3bf9bf08dfc629bb3f0a152eb20b869a636
2024-04-05build-system/channel: Add support for additional channels.Ludovic Courtès
Until now, ‘channel-build-system’ would assume a single channel, the ‘guix’ channel. This change lets users specify additional channels using the #:channels parameter. * guix/build-system/channel.scm (build-channels): Add #:channels and honor it. (channel-build-system): In ‘lower’, add #:channels and honor it. * doc/guix.texi (Build Systems): Document it. Change-Id: I36c1d19cbeee02a4d1144de089b78df0390774a0
2024-04-05guix-install.sh: Add ‘--uninstall’ flag.Ludovic Courtès
* etc/guix-install.sh (REQUIRE): Add groupdel and userdel. (chk_term): Handle ‘WAR’. (sys_delete_store, sys_delete_build_user, sys_delete_guix_daemon) (sys_delete_init_profile, sys_delete_user_profiles): New functions. (main): Rename to… (main_install): … this. (main_uninstall): New function. (main): Dispatch between these two. * doc/guix.texi (Installation): Refer to “Binary Installation” instead of repeating it. (Binary Installation): Document uninstallation. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I55b7c10823773bced2e268273e8ce828cb3bd98d
2024-04-05doc: Explain to run bootstrap after Automake errors.Florian Pelz
Fixes <https://issues.guix.gnu.org/70140>. Suggested by Rostislav Svoboda <rostislav.svoboda@gmail.com>. * doc/contributing.texi (Building from Git): Explain. * doc/guix.texi: Update copyright year. Change-Id: I0cedc60f9ece3ec78df60df54ffeacff545bfc63
2024-04-03Switch order of the default substitute servers.Christopher Baines
The aim here is to improve the user experience. There's anecdotal evidence that the network performance for bordeaux is better compared to ci at least for some users, and I don't know of any issues with rate limiting or access restriction for bordeaux compared to ci. It also has IPv6 support. Additionally, bordeaux generally had more substitutes than ci, particularly for aarch64-linux and armhf-linux. This change will offer a very slight speedup for those substitutes that only bordeaux has. Bordeaux has been a default substitute server for nearly 3 years now and I think this change is overdue. I'm also hopeful that we'll be able to build on the testing regarding mirrors for bordeaux, and that'll allow potentially improving the hosting setup (through providing more redundancy) and further improving substitute fetching for users who currently have issues with substitute access. * config-daemon.ac: Switch substitute urls order. * doc/guix.texi: Ditto. * etc/guix-install.sh: Ditto. * gnu/installer/newt/network.scm (wait-service-online): Ditto. * guix/store.scm (%default-substitute-urls): Ditto. Change-Id: I4f6d93ae1fc8b03d80b47b18b5749a51f1fde17b Signed-off-by: Christopher Baines <mail@cbaines.net>
2024-03-30Merge branch 'gnome-team'Liliana Marie Prikler
2024-03-30doc: Cross-reference virtual build machines from ‘guix time-machine’.Ludovic Courtès
* doc/guix.texi (Invoking guix time-machine): Tweak the note about packages that may fail to build. Add cross-reference to virtual build machines. Change-Id: Ib2a4a28cdca0c8970d0f5327e39b4a21800ea2e1
2024-03-30doc: ‘guix time-machine’ can travel to v0.16.0.Ludovic Courtès
This is a followup to a26bce55e60aa3444c4378d3996f3aa41b9661e9. * doc/guix.texi (Invoking guix time-machine): Update reference to oldest commit. Change-Id: Iae3d751d4377de92481276f9f2f31128f85c23c4
2024-03-25services: nar-herder: Add new configuration options.Christopher Baines
* gnu/services/guix.scm (nar-herder-configuration-new-ttl, nar-herder-cached-compression-configuration-unused-removal-duration, nar-herder-cached-compression-configuration-ttl, nar-herder-cached-compression-configuration-new-ttl): New procedure. (nar-herder-shepherd-services): Handle the new options. * doc/guix.texi (Guix Services): Document the new nar-herder options. Change-Id: I161e490221a3ce394e32ada685dca27df60638bb
2024-03-22doc: Mention channel files beyond ~/.config/guix.Ludovic Courtès
* doc/guix.texi (Channels): Instead of mentioning just ~/.config/guix/channels.scm, mention channel files in general and link to “Invoking guix pull”. Change-Id: Iefb8a2d5ee5d804b2b6319785842fc3a97704495
2024-03-22services: guix: Add ‘channels’ field.Antero Mejr
* doc/guix.texi (Base Services): Document 'guix-configuration-channels' field. (Invoking guix pull): Add cross-reference. * gnu/services/base.scm (install-channels-file): New procedure. (guix-configuration): Add channels field. (guix-activation): Use 'install-channels-file' procedure. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Change-Id: I4d89235bf0bc6dde69984138ccb894b48ace9d76
2024-03-21doc: Add “Source Tree Structure” section.Ludovic Courtès
* doc/contributing.texi (Source Tree Structure): New node. * doc/guix.texi (Programming Interface): Add cross-reference. Change-Id: I141a1f4d806ae5f72c7a246e18c14dc63056a607
2024-03-21doc: Update ‘block-facebook-hosts-service-type’ description.Ludovic Courtès
This is a followup to c1d37d0653766c8de52e22bae01701baf503338f. * doc/guix.texi (Networking Services): Update to mention unroutable addresses. Change-Id: I6f62e1f414a3eb7892b2d4cc0d011458bbec7001
2024-03-20Merge remote-tracking branch 'savannah/master' into gnome-teamChristopher Baines
Change-Id: Iec8e15b79c6fde516294c2bfcaf8ee3575b1f745
2024-03-19git authenticate: Document ‘--end’.Ludovic Courtès
* guix/scripts/git/authenticate.scm (show-help): Document ‘--end’. * doc/guix.texi (Invoking guix git authenticate): Likewise. Reported-by: Tomas Volf <~@wolfsden.cz> Change-Id: Ia646203ce2f721487de547c76b9488754c70db66
2024-03-19doc: Adjust for QEMU info manual name change.Maxim Cournoyer
* doc/guix.texi (Networking Setup): Change QEMU to qemu for its info manual reference. Change-Id: I55f57e66947f2581531c15fd5228a3ca043a9574
2024-03-17gnu: services: Add insecure-sasl-mechanisms to prosody configuration.Carlo Zancanaro
* gnu/services/messaging.scm (prosody-configuration): Add insecure-sasl-mechanisms configuration option. * doc/guix.texi (Messaging Services): Document it. Change-Id: I8d9e42476ea8ad2f89b143ed4a66b4798e418586 Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com>
2024-03-16doc: Correct the "guix package --install-from-expression" example.Rostislav Svoboda
* doc/guix.texi (Invoking @command{guix package}): Correct the module where 'guile-final' is defined. It is actually located in (gnu packages commencement) rather than in the (gnu packages base). Change-Id: I7747106916d53dcbe296b7302983c5013eb2926d Signed-off-by: Christopher Baines <mail@cbaines.net>
2024-03-16Merge remote-tracking branch 'savannah/master' into gnome-teamChristopher Baines
Change-Id: I775274c2693536e2efa36c9abca4c54c5c458e26
2024-03-14doc: Fix section on LUKS support.Fabio Natali
Only LUKS1 is supported in Guix at the time of this commit. Contrarily to what reported in previous versions of this section, LUKS2 is not supported. * doc/guix.texi (Keyboard Layout, Networking, and Partitioning)[Disk Partitioning]: Fix section on LUKS support. Signed-off-by: Christopher Baines <mail@cbaines.net> Change-Id: Ia670963178810174d3ea4585c537defbaaeb0f25
2024-03-10Merge branch 'master' into gnome-teamLiliana Marie Prikler
2024-03-06gnu: home: dotfiles: Properly support both plain and Stow directory layouts.Giacomo Leidi
Fixes <https://issues.guix.gnu.org/68848>. The current implementation of the home-dotfiles-service-type contradicts the Guix manual. This patch properly implements both the plain and Stow dotfiles directory layouts. It does so by refactoring home-dotfiles-configuration adding a new packages field to support GNU Stow's users workflow and introducing a new layout field to switch between the two directory layouts. * gnu/home/services/dotfiles (home-dotfiles-configuration): Migrate to (gnu services configuration); [packages]: new field; [layout]: new field; (strip-stow-dotfile): new variable; (strip-plain-dotfile): new variable; (home-dotfiles-configuration->files): use the new fields; [directory-contents]: allow for selecting a subset of application dotfile directories; * doc/guix.texi: document the new layouts. Change-Id: I2e96037608353e360828290f055ec5271cfdfd48 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-03-06doc: Fix typo in “Getting Started with the System”.Ludovic Courtès
* doc/guix.texi (Getting Started with the System): Fix typo. Change-Id: Idc52b9a4d5f5003899613595b6b275e098f6a3a8
2024-03-02doc: Add “Inspecting Services” section.Ludovic Courtès
* doc/guix.texi (Inspecting Services): New subsection. Change-Id: I71378101de913a494e0d0e93cc76434c5a70b520
2024-03-02doc: Add “Getting Started with the System” section.Ludovic Courtès
* doc/guix.texi (Getting Started with the System): New node. (After System Installation): Refer to it. Move note about ‘sudo guix pull’ to the “Getting Started with the System”. (Getting Started): Refer to it. Move note about ‘guix system roll-back’ to “Getting Started with the System”. (Features): Refer to it. (Using the Configuration System): Adjust intro. Add “Troubleshooting” note that mentions ‘guix style -f’ for misplaced parens. (Instantiating the System): Simplify and cross-reference “Getting Started with the System”. Change-Id: Ie74f598450e8059a4579a016e2aeca2edd7696a7
2024-03-02Merge branch 'master' into gnome-teamLiliana Marie Prikler
2024-02-27doc: Document required setup steps for Nix service.Carlo Zancanaro
* doc/guix.texi (Nix service): Add specific channel setup commands, add commands to create profile directory. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-02-25Merge branch 'master' into gnome-teamLiliana Marie Prikler
2024-02-23import: Insert packages into modules alphabetically.Herman Rimm
* guix/scripts/import.scm (guix-import): Add 'insert' option. (import-as-definitions): Add procedure. * doc/guix.texi (Invoking guix import): Describe 'insert' option. Change-Id: Id87ea707123630e12bcb6788599acac6895b26c4 Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-02-23doc: Note SVN dependency of texlive importer.Herman Rimm
* doc/guix.texi (Invoking guix import): Note dependency and remove duplicated words. Change-Id: I94320db8c8ab3569aa461876522d5560e37a19ea Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-02-21doc: Refine wording of binary installation introductory text.Maxim Cournoyer
* doc/guix.texi (Binary Installation): Mention the requirement to use a Hurd or Linux kernel for the binary installation. Suggested-by: Matt <matt@excalamus.com> Change-Id: Ibc0552f59be4fdaaf8d44a5222e6feb925d3f06f
2024-02-20doc: Augment ‘whoogle-service-type’ intro.Ludovic Courtès
* doc/guix.texi (Whoogle Search): Enrich a bit. Change-Id: Ib7e1da1c0709167d02c43ab991f3ae34fbc09c84
2024-02-20services: Add whoogle-service-type.Miguel Ángel Moreno
* gnu/services/web.scm (whoogle-service-type): New variable. * doc/guix.texi (Web Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-02-18services: virtual-build-machine: Add ‘configuration’ action.Ludovic Courtès
* gnu/services/virtualization.scm (build-vm-shepherd-services): Add ‘configuration’ action. * doc/guix.texi (Virtualization Services): Document it. Change-Id: I4734e096d744b3cda0d523692498a73c0029e188
2024-02-13Merge branch 'master' into gnome-teamLiliana Marie Prikler
2024-02-10services: Add ‘virtual-build-machine’ service.Ludovic Courtès
* gnu/services/virtualization.scm (<virtual-build-machine>): New record type. (%build-vm-ssh-port, %build-vm-secrets-port, %x86-64-intel-cpu-models): New variables. (qemu-cpu-model-for-date, virtual-build-machine-ssh-port) (virtual-build-machine-secrets-port): New procedures. (%minimal-vm-syslog-config, %virtual-build-machine-operating-system): New variables. (virtual-build-machine-default-image): (virtual-build-machine-account-name) (virtual-build-machine-accounts) (build-vm-shepherd-services) (initialize-build-vm-substitutes) (build-vm-activation) (virtual-build-machine-offloading-ssh-key) (virtual-build-machine-activation) (virtual-build-machine-secret-root) (check-vm-availability) (build-vm-guix-extension): New procedures. (initialize-hurd-vm-substitutes): Remove. (hurd-vm-activation): Rewrite in terms of ‘build-vm-activation’. * gnu/system/vm.scm (linux-image-startup-command): New procedure. (operating-system-for-image): Export. * gnu/tests/virtualization.scm (run-command-over-ssh): New procedure, extracted from… (run-childhurd-test): … here. [test]: Adjust accordingly. (%build-vm-os): New variable. (run-build-vm-test): New procedure. (%test-build-vm): New variable. * doc/guix.texi (Virtualization Services)[Virtual Build Machines]: New section. (Build Environment Setup): Add cross-reference. Change-Id: I0a47652a583062314020325aedb654f11cb2499c
2024-02-05gnu: mbedtls-apache: Rename to mbedtls-lts.Hilton Chain
* gnu/packages/tls.scm (mbedtls-apache): Rename package to "mbedtls". Rename variable to… (mbedtls-lts): …this. (mbedtls-apache): Define as deprecated by mbedtls-lts. (mbedtls-for-hiawatha): Adjust accordingly. * doc/guix.texi: Likewise. * gnu/packages/emulators.scm (dolphin-emu,retroarch)[inputs]: Likewise. * gnu/packages/game-development.scm (godot-lts,godot)[inputs]: Likewise. * gnu/packages/hardware.scm (hueplusplus,openrgb)[inputs]: Likewise. * gnu/packages/haxe.scm (neko,haxe,hashlink)[inputs]: Likewise. * gnu/packages/irc.scm (inspircd)[inputs]: Likewise. * gnu/packages/julia-jll.scm (julia-mbedtls-jll)[arguments]<#:phases>,[inputs]: Likewise. * gnu/packages/julia.scm (julia)[arguments]<#:phases>,[inputs]: Likewise. * gnu/packages/linphone.scm (bctoolbox)[inputs]: Likewise. * gnu/packages/linux.scm (dislocker)[inputs]: Likewise. * gnu/packages/networking.scm (nng)[inputs]: Likewise. * gnu/packages/search.scm (dataparksearch)[inputs]: Likewise. * gnu/packages/video.scm (obs)[inputs]: Likewise. * gnu/packages/web.scm (hiawatha)[arguments]<#:phases>: Likewise. Change-Id: I0c58b3cd0bcf6e44e7b16a69f6d2739aa3c1545b
2024-02-03Merge branch 'master' into gnome-teamLiliana Marie Prikler
2024-01-31services: certbot: Reload nginx in deploy hook.Carlo Zancanaro
* gnu/services/certbot.scm (certbot-deploy-hook): Reload nginx. * doc/guix.texi (Certificate services): Remove deploy-hook from example. Change-Id: Ibb10481170a6fda7df72492072b939dd6a6ad176 Signed-off-by: Clément Lassieur <clement@lassieur.org>
2024-01-31services: certbot: Create self-signed certificates before certbot runs.Carlo Zancanaro
* gnu/services/certbot.scm (<certificate-configuration>): Add start-self-signed? field. (generate-certificate-gexp): New procedure. (certbot-activation): Generate self-signed certificates when start-self-signed? is #t. * doc/guix.texi (Certificate services): Document start-self-signed?. Change-Id: Icfd85ae0c3e29324acbcde6ba283546cf0e27a1d Signed-off-by: Clément Lassieur <clement@lassieur.org>
2024-01-31services: certbot: Symlink certificates to /etc/certs.Carlo Zancanaro
* gnu/services/certbot.scm (certbot-deploy-hook): New procedure. (certbot-command): Pass new deploy hook to certbot. * doc/guix.texi: Replace "letsencrypt/live" with "certs" throughout, except in the certbot deploy-hook description. Change-Id: I2ba5e4903d1e293e566b732a84b07d5a134b697d Signed-off-by: Clément Lassieur <clement@lassieur.org>
2024-01-28services: shepherd: Add respawn-limit and respawn-delay.Attila Lendvai
* gnu/services/shepherd.scm (<shepherd-service>): Add respawn-limit and respawn-delay. (shepherd-service-file): Emit the two values into the shepherd service constructor form. Change-Id: I54408e8fb4bcc0956d9610771bf5c566fdc2914c Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2024-01-28doc: Add index entries for “dot files” and “Stow”.Ludovic Courtès
* doc/guix.texi (Essential Home Services): Add index entries. Change-Id: I0c3a5f5d94fe273c137eb3ca5fa6c5c91a34599b
2024-01-28home: Add home-dotfiles-service.Giacomo Leidi
* gnu/home/service/dotfiles.scm: New file; * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * po/guix/POTFILES.in: Add it. * doc/guix.texi (Essential Home Services): Document it. Change-Id: I6769169cfacefc3842faa5b31bee081c56c28743 Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2024-01-27doc: Fix typo.Florian Pelz
Follow-up to 3872ecf274ca53a5c195f6b51081474876897565. * doc/guix.texi (Complex Configurations): Use correct variable name.
2024-01-26doc: Define mumble-server-service-type as a variable.Maxim Cournoyer
Using defvar for service types causes them to be part of the index, which is useful for discoverability. * doc/guix.texi (Telephony Services) <mumble-server-service-type>: Define with defvar. Change-Id: I01bed0c86ff12425a81294cb12f1b2a8bd14cd6f