summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2021-06-01maint: Require Guile 3.0.Ludovic Courtès
* configure.ac: Require Guile 3.0. * doc/guix.texi (Requirements): Adjust accordingly. * gnu/packages/package-management.scm (guile2.2-guix): Remove. * guix/lint.scm (exception-with-kind-and-args?): Remove 'cond-expand'. * guix/scripts/deploy.scm (deploy-machine*): Likewise. * guix/store.scm (call-with-store): Likewise. * guix/swh.scm (http-get*, http-post*): Likewise. * guix/ui.scm (without-compiler-optimizations, guard*) (call-with-error-handling): Likewise.
2021-05-31tests: Fix loadable-kernel-modules-service tests.Brice Waegeneire
* gnu/tests/linux-modules.scm (run-loadable-kernel-modules-service-test): Actually load the modules with kernel-module-loader-service-type. Use a singleton service instead of defining a custom one. * doc/guix.texi (Service Reference): To give an example of linux-loadable-module-service-type use a singleton instead of defining a new service.
2021-05-30doc: Add a note about networking requirements for SSH access to VMs.Maxim Cournoyer
Fixes <https://issues.guix.gnu.org/48739>. It may seem silly, but when not realizing this firsthand, it can be quite surprising and thus not obvious to troubleshoot. Thanks to Eric Brown for their insightful comments on the tracker. * doc/guix.texi (Running Guix in a VM): Add a note that networking support must be available in the Guix System operating system declaration used for the VM.
2021-05-30doc: Fix typos.Tobias Geerinckx-Rice
* doc/contributing.texi (Translating Guix): Fix ‘runnig’ typo. Replace ‘target’ with ‘command’ to match the verb. Fix ‘refered’ and ‘formating’ too.
2021-05-29doc: lxqt-desktop-service: Update lxqt homepage url.Brendan Tildesley
* doc/guix.texi: Replace lxqt.github.io with lxqt-project.org. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-05-28doc: Spell out the implications of disabling substitutes.Ludovic Courtès
Suggested by elb on #guix. * doc/guix.texi (Binary Installation): Add note explaining the implications of disabling substitutes.
2021-05-25doc: Remove reference to mips64.Efraim Flashner
* doc/contributing.texi (Submitting Patches): Don't suggest building packages for mips64.
2021-05-23doc: Correct spellingFilip Lajszczak
* doc/contributing.tex (Submitting Patches): Correct spelling of "acknowledgement" Co-authored-by: Piotr Kaznowski <piotr@kazno.dev> Signed-off-by: Marius Bakke <marius@gnu.org>
2021-05-22doc: Add information about first patch.Filip Lajszczak
* doc/contributing.texi (Submitting Patches): Add information about first patch acnowledgement delay. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-05-20The #guix channel is hosted by Libera Chat.Tobias Geerinckx-Rice
* README (Contact): Update network name. * ROADMAP: Likewise. * doc/contributing.texi (Contributing): Likewise. * doc/guix.texi (After System Installation): Likewise.
2021-05-19doc: Fix references to the "geiser" package.Ludovic Courtès
Reported by munksgaard on #guix. * doc/guix.texi (Invoking guix pack): Replace "geiser" with "emacs-geiser" in examples. (Invoking guix refresh): Likewise.
2021-05-17services: Add a service for opendht.Maxim Cournoyer
* gnu/services/networking.scm (maybe-number?, maybe-string?): New procedures. (<opendht-configuration>): New configuration record. (%opendht-accounts): New variable. (opendht-configuration->command-line-arguments): New procedure. (opendht-shepherd-service, opendht-service-type): New variables. * doc/guix.texi (Networking Services): Document the new service.
2021-05-16publish: Add '--negative-ttl'.Ludovic Courtès
* guix/scripts/publish.scm (show-help, %options): Add '--negative-ttl'. (render-narinfo, render-narinfo/cached, make-request-handler): Add #:negative-ttl and honor it. (run-publish-server): Add #:narinfo-negative-ttl and honor it. (guix-publish): Honor '--negative-ttl'. * tests/publish.scm ("negative TTL", "no negative TTL"): New tests.
2021-05-13doc: Show how to enable Guile support for Geiser.Jelle Licht
* doc/contributing.texi (The Perfect Setup): Adjust "guix package -i" command line.
2021-05-12doc: Do not instruct to decompress the VM image.Maxim Cournoyer
Also replace the obsolete 'guix system vm-image' command mention by the 'guix system image'. * doc/guix.texi (Running Guix in a VM): Remove VM image decompression instruction. <guix system vm-image>: Replace by 'guix system image'.
2021-05-11Merge branch 'version-1.3.0'Maxim Cournoyer
2021-05-11gnu: Allow services to install kernel-loadable modules.raid5atemyhomework
* gnu/system.scm (operating-system-directory-base-entries): Remove code to handle generation of "kernel" for linux-libre kernels. (operating-system-default-essential-services): Instantiate linux-builder-service-type. (package-for-kernel): Move ... * gnu/services.scm: ... to here. (linux-builder-service-type): New variable. (linux-builder-configuration): New type. (linux-loadable-module-service-type): New variable. * gnu/tests/linux-modules.scm (run-loadable-kernel-modules-test): Move code to ... (run-loadable-kernel-modules-test-base): ... new procedure here. (run-loadable-kernel-modules-service-test): New procedure. (%test-loadable-kernel-modules-service-0): New variable. (%test-loadable-kernel-modules-service-1): New variable. (%test-loadable-kernel-modules-service-2): New variable. * doc/guix.texi: Document linux-loadable-module-service-type. Signed-off-by: Danny Milosavljevic <dannym@scratchpost.org>
2021-05-06services: dovecot: Add ‘managesieve-sieve-capability’ option.Alexey Abramov
* gnu/services/mail.scm (protocol-configuration): Add a ‘managesieve-sieve-capability’ field. * doc/guix.texi (Mail Services): Document it. Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr>
2021-05-06services: dovecot: Add ‘managesieve-notify-capability’ option.Alexey Abramov
* gnu/services/mail.scm (protocol-configuration): Add a ‘managesieve-notify-capability’ field. * doc/guix.texi (Mail Services): Document it. Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr>
2021-05-06services: dovecot: Add ‘imap-metadata?’ protocol configuration option.Alexey Abramov
* gnu/services/mail.scm (protocol-configuration): Add an ‘imap-metadata?’ setting to enable IMAP METADATA support in the ‘imap’ protocol. * doc/guix.texi (Mail Services): Document it. Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr>
2021-05-06services: dovecot: Add ‘mail-attribute-dict’ configuration option.Alexey Abramov
* gnu/services/mail.scm (dovecot-configuration): Define a ‘mail-attribute-dict’ directive for IMAP METADATA storage. * doc/guix.texi (Mail Services): Document it. Signed-off-by: Tobias Geerinckx-Rice <me@tobias.gr>
2021-05-05gnu: rasdaemon: Fix Texinfo syntax of description.Ludovic Courtès
Regression introduced in 58805da44dac6b180245edd8a6419343f64d221c. * gnu/packages/linux.scm (rasdaemon)[description]: Avoid @acronym since Guile's Texinfo module doesn't currently support @comma{}. * doc/guix.texi (Linux Services): Use @comma{} within @acronym.
2021-05-05build: Do not compress the (already compressed) VM qcow2 images.Maxim Cournoyer
The qcow2 format supports compression, and the qcow2 type supported by 'guix system image' produces compressed qcow2 images. * Makefile.am (release): Do not re-compress the qcow2 VM images with xz. * doc/guix.texi (Running Guix in a VM): Adjust VM image URL.
2021-05-05Revert "doc: Update to cover for an additional OpenPGP signing key."Maxim Cournoyer
This reverts commit b9fb13b28437a254683273094f189396a6e1421d. Per discussions simply updating OPENPGP-SIGNING-KEY-ID and OPENPGP-SIGNING-KEY-URL will be enough.
2021-05-05doc: Update the OpenPGP key used to sign the release.Maxim Cournoyer
It was discussed on guix-devel that the manual only needs to have correct instructions for the latest release. * doc/guix.texi (OPENPGP-SIGNING-KEY-ID): Update to my public OpenPGP key. (OPENPGP-SIGNING-KEY-URL): Adjust URL.
2021-05-05Revert "doc: Update to cover for an additional OpenPGP signing key."Maxim Cournoyer
This reverts commit b9fb13b28437a254683273094f189396a6e1421d. Per discussions simply updating OPENPGP-SIGNING-KEY-ID and OPENPGP-SIGNING-KEY-URL will be enough.
2021-05-04doc: Fix typo and use @acronym for RAS.Tobias Geerinckx-Rice
* doc/guix.texi (Linux Services): Fix typo and use @acronym for RAS.
2021-05-04doc: Fix typos.Tobias Geerinckx-Rice
* doc/contributing.texi (Translating Guix): Fix ‘developpers’ and ‘superseeded’ typos. Use @var mark-up where appropriate.
2021-05-03doc: Update to cover for an additional OpenPGP signing key.Maxim Cournoyer
The upcoming 1.3.0 release will be signed with my OpenPGP key; subsequent releases may also be. * doc/guix.texi (OPENPGP-SIGNING-KEY-ID, OPENPGP-SIGNING-KEY-URL): Rename to... (OPENPGP-SIGNING-KEY-ID-1, OPENPGP-SIGNING-KEY-URL-1): ... these, respectively. (OPENPGP-SIGNING-KEY-ID-2, OPENPGP-SIGNING-KEY-URL-2): New variables. (Binary Installation): Adjust to cover for the new key. (USB Stick and DVD Installation): Likewise. (Invoking guix refresh): Adjust accordingly.
2021-05-03maint: Do not xz-compress ISO images.Ludovic Courtès
The xz-compressed image is 23% smaller than the original ISO image (with built-in zlib compression), but the extra decompression step is unconventional and often a hindrance for users. See discussion at <https://lists.gnu.org/archive/html/guix-devel/2021-04/msg00497.html>. * Makefile.am (release): Do not compress ISO images. * doc/guix.texi (USB Stick and DVD Installation): Remove ".xz" suffix from URL and file name. (Copying to a USB Stick, Burning on a DVD): Remove introductory words, @enumerate, and first item. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2021-05-03nls: Guard against the list of translated Texinfo files becoming stale.Julien Lepiller
This change is so that the list of translated Texinfo files remain in sync with the list of supported (translated) languages. * doc/local.mk (MANUAL_LANGUAGES, COOKBOOK_LANGUAGES): New variables. (lang_to_texinfos): New function. (TRANSLATED_INFO): Use it to construct the list of files. Modified-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
2021-05-03doc: Update to cover for an additional OpenPGP signing key.Maxim Cournoyer
The upcoming 1.3.0 release will be signed with my OpenPGP key; subsequent releases may also be. * doc/guix.texi (OPENPGP-SIGNING-KEY-ID, OPENPGP-SIGNING-KEY-URL): Rename to... (OPENPGP-SIGNING-KEY-ID-1, OPENPGP-SIGNING-KEY-URL-1): ... these, respectively. (OPENPGP-SIGNING-KEY-ID-2, OPENPGP-SIGNING-KEY-URL-2): New variables. (Binary Installation): Adjust to cover for the new key. (USB Stick and DVD Installation): Likewise. (Invoking guix refresh): Adjust accordingly.
2021-05-03doc: Update the URL of the system VM image.Maxim Cournoyer
This is a follow up to commit ebf5d77eab, which added the qcow2 file extension to the VM image file name. * doc/guix.texi (Running Guix in a VM): Update URL.
2021-04-27services: mysql: Add extra-environment as configuration option.methuselah-0
* gnu/services/databases.scm (mysql-configuration): Add extra-environment (mysql-service): Use #:log-file and #:environment-variables * doc/guix.texi: Document it. Signed-off-by: Leo Prikler <leo.prikler@student.tugraz.at>
2021-04-26doc: Remove extraneous spaces from the net-options default value snippet.Maxim Cournoyer
Adapting the snippet corresponding to the default value of the net-options field of the hurd-vm-configuration record shown in the manual would easily lead to a broken childhurd service, due to the presence of extraneous spaces in the option string. * doc/guix.texi (Virtualization Services)[hurd-vm-configuration] <net-options>: Use string-append to properly form the option string.
2021-04-26doc: Clarify the utility of the development branches.Leo Famulari
* doc/contributing.texi (Submitting Patches): Clarify the utility of the 'staging' and 'core-updates' branches.
2021-04-25doc: Document translation process.Julien Lepiller
doc/contributing.texi (Translating Guix): New section. doc/guix.texi (Top): Add a reference to the new section.
2021-04-25doc: Fix cross-reference URL to translated manual.Julien Lepiller
* doc/htmlxref.cnf: Fix translated manual URL.
2021-04-25import: Remove Nix importer.Ludovic Courtès
This importer has suffered from bitrot and no longer works with current Nix and Nixpkgs. See <https://bugs.gnu.org/32339> and <https://bugs.gnu.org/36255>. * guix/import/snix.scm, guix/scripts/import/nix.scm, tests/snix.scm: Remove. * Makefile.am (MODULES, SCM_TESTS): Remove them. * guix/scripts/import.scm (importers): Remove "nix". * build-aux/test-env.in: Remove NIXPKGS variable. * configure.ac: Remove '--with-nixpkgs' option. * doc/guix.texi (Invoking guix import): Remove bit about "guix import nix". * etc/completion/fish/guix.fish: Likewise.
2021-04-24services: Add a service for rasdaemon.B. Wilson
* gnu/services/linux.scm (rasdaemon-configuration, rasdaemon-configuration?, rasdaemon-configuration-record?, rasdaemon-service-type): New variables. * doc/guix.texi (Linux Services): Document it. Signed-off-by: Leo Famulari <leo@famulari.name>
2021-04-24doc: Fix cross-reference URL to translated manual.Julien Lepiller
* doc/htmlxref.cnf: Fix translated manual URL.
2021-04-23services: guix-build-coordinator: Fix queue builds default config.Christopher Baines
Use the default client port rather than the default agent communication port for the queue builds script. * gnu/services/guix.scm (<guix-build-coordinator-queue-builds-configuration>): Change coordinator default.
2021-04-23services: guix-build-coordinator: Add max-1min-load-average option.Christopher Baines
To the agent configuration. * gnu/services/guix.scm (<guix-build-coordinator-agent-configuration>): New field, max-1min-load-average. (guix-build-coordinator-agent-configuration-max-1min-load-average): New procedure. (guix-build-coordinator-agent-shepherd-services): If set, include the max-1min-load-average in the agent arguments.
2021-04-22doc: Update TRANSLATED_INFO.Leo Prikler
This fixes issues with missing sources when the infos are built. * doc/local.mk (TRANSLATED_INFO): Add missing documents.
2021-04-20doc: Clarify further the distinction between the web-based manuals.Leo Famulari
As discussed on #guix IRC, several of us struggle to reliably choose the right option based on the old labels: https://logs.guix.gnu.org/guix/2021-04-20.log#182137 * doc/build.scm (html-manual-indexes): Try to distinguish between the two options more clearly.
2021-04-20services: wireguard: Add keep-alive support.Guillaume Le Vaillant
* gnu/services/vpn.scm (<wireguard-peer>): Add 'keep-alive' field. (wireguard-configuration-file): Use it. * doc/guix.texi (VPN Services): Document it.
2021-04-20import: Remove Nix importer.Ludovic Courtès
This importer has suffered from bitrot and no longer works with current Nix and Nixpkgs. See <https://bugs.gnu.org/32339> and <https://bugs.gnu.org/36255>. * guix/import/snix.scm, guix/scripts/import/nix.scm, tests/snix.scm: Remove. * Makefile.am (MODULES, SCM_TESTS): Remove them. * guix/scripts/import.scm (importers): Remove "nix". * build-aux/test-env.in: Remove NIXPKGS variable. * configure.ac: Remove '--with-nixpkgs' option. * doc/guix.texi (Invoking guix import): Remove bit about "guix import nix". * etc/completion/fish/guix.fish: Likewise.
2021-04-18doc: Build the French HTML cookbook.Julien Lepiller
* doc/build.scm (%languages): Add 'fr' cookbook translation.
2021-04-18nls: Add Chinese (Traditional) translation.Julien Lepiller
* po/doc/guix-cookbook.zh_Hans.po: New file. * doc/local.mk (info_TEXINFOS): Add it. * po/doc/local.mk (DOC_COOKBOOK_PO_FILES): Add it.
2021-04-18nls: Add Korean translation.Julien Lepiller
* po/doc/guix-cookbook.ko.po: New file. * po/doc/guix-manual.ko.po: New file. * doc/local.mk (info_TEXINFOS): Add them. * po/doc/local.mk (DOC_PO_FILES, DOC_COOKBOOK_PO_FILES): Add them. * po/guix/ko.po: New file. * po/guix/LINGUAS: Add 'ko'. * po/packages/ko.po: New file. * po/packages/LINGUAS: Add 'ko'.