summaryrefslogtreecommitdiff
path: root/doc/guix.texi
AgeCommit message (Expand)Author
2021-05-03maint: Do not xz-compress ISO images....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> Ludovic Courtès
2021-05-03doc: Update to cover for an additional OpenPGP signing key....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. Maxim Cournoyer
2021-05-03doc: Update the URL of the system VM image....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. Maxim Cournoyer
2021-04-27services: mysql: Add extra-environment as configuration option....* 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> methuselah-0
2021-04-26doc: Remove extraneous spaces from the net-options default value snippet....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. Maxim Cournoyer
2021-04-25doc: Document translation process....doc/contributing.texi (Translating Guix): New section. doc/guix.texi (Top): Add a reference to the new section. Julien Lepiller
2021-04-25import: Remove Nix importer....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. Ludovic Courtès
2021-04-24services: Add a service for rasdaemon....* 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> B. Wilson
2021-04-23services: guix-build-coordinator: Fix queue builds default config....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. Christopher Baines
2021-04-23services: guix-build-coordinator: Add max-1min-load-average option....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. Christopher Baines
2021-04-20services: wireguard: Add keep-alive support....* gnu/services/vpn.scm (<wireguard-peer>): Add 'keep-alive' field. (wireguard-configuration-file): Use it. * doc/guix.texi (VPN Services): Document it. Guillaume Le Vaillant
2021-04-20import: Remove Nix importer....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. Ludovic Courtès
2021-04-14git: Honor proxy settings when fetching submodules....Fixes <https://bugs.gnu.org/44593>. * guix/git.scm (update-submodules): Add #:fetch-options and honor it. (update-cached-checkout): Pass #:fetch-options to 'update-submodules'. * doc/guix.texi (Requirements): Adjust comment about Guile-Git. Ludovic Courtès
2021-04-14Revert "services: mysql: Add extra-environment as configuration option."...This reverts commit f3626119d738f30b5ab59e76c105fd7b4c077ddc. This commit inadvertently broke a string freeze. Let's be nice to our translators and not do that. Leo Prikler
2021-04-13services: mysql: Add extra-environment as configuration option....* 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> methuselah-0
2021-04-12services: postgresql: Change service default socket directory....Fixes <https://bugs.gnu.org/46737>. PostgreSQL running with a different socket directory to the default one in the package itself breaks some services, this commit restores the previous behaviour where PostgreSQL by default will run with a socket directory that matches the default used by PostgreSQL packaged for Guix. Switching to a different default value can happen, but only alongside changing the PostgreSQL package. * gnu/services/databases.scm (<postgresql-config-file>)[socket-directory]: Change default to #false. * doc/guix.texi (Database Services): Update documentation, and specify a different value for disabling connections via sockets. * gnu/tests/guix.scm (%guix-data-service-os): Use default PostgreSQL behaviour. * gnu/tests/monitoring.scm (%zabbix-os): Likewise. * gnu/tests/web.scm (patchwork-os): Likewise. Signed-off-by: Leo Famulari <leo@famulari.name> Christopher Baines
2021-04-12doc: Document 'gnu-build-system' keyword parameters....* doc/guix.texi (Build Systems): Document keyword parameters of 'gnu-build-system'. Ludovic Courtès
2021-04-12doc: Move list of build phases to "Build Phases"....Before this change, the 'gnu-build-system' phases were listed in the "Build Systems" section, and then summarized in the "Build Phases" section. This moves everything to "Build Phases". * doc/guix.texi (Build Systems): Move phase table to... (Build Phases): ... here. Rearrange surrounding text. Ludovic Courtès
2021-04-12services: Add ipfs-service-type...* gnu/services/networking.scm (ipfs-service-type) (%ipfs-home-mapping, %ipfs-environment) (%ipfs-accounts, %ipfs-home): New variables. (ipfs-configuration, ipfs-configuration?) (ipfs-configuration-package, ipfs-configuration-gateway) (ipfs-configuration-api, ipfs-shepherd-service) (ipfs-binary, %ipfs-activation): New procedures. * doc/guix.texi (Networking Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Maxime Devos
2021-04-12services: Support DELETE in MODIFY-SERVICES macro....* gnu/services.scm (%modify-service): Add clause for DELETE syntax. (modify-services): Use FILTER-MAP; adjust docstring. * doc/guix.texi (System Services): Mention alternative syntax. (X Window): Use MODIFY-SERVICES syntax. Ricardo Wurmus
2021-04-11doc: Fix connect to the VM over SSH example....* doc/guix.texi (Running Guix in a VM): Add host which connect to in SSH connection example. Oleg Pykhalov
2021-04-10doc: Fix typos....* doc/guix.texi (SELinux Support): Fix typo. (Build Systems): Likewise. (DNS Services): Likewise. (Networking Services): Likewise. (Guix Services): Likewise. (Reduced Binary Seed Bootstrap): Likewise. (Documentation): Likewise. Tobias Geerinckx-Rice
2021-04-09import: go: Append version to symbol name in the pinned version mode....This allows importing packages with complicated version specific dependency chains without the package symbol names colliding. * doc/guix.texi (Invoking guix import): Document the --pin-versions option. Mention that a specific version can be imported. Remove the experimental warning. * guix/import/go.scm (go-module->guix-package-name)[version]: Add optional argument. Rewrite the character translation in terms of string-map. (go-module->guix-package): Conditionally use dependencies whose symbol include their version, based no the value of the PIN-VERSIONS? argument. * guix/import/utils.scm (package->definition): Add a new case where the full version string is appended to the package symbol. * guix/scripts/import.scm (guix-import): Correctly print forms starting with '(define-public [...]'. * guix/scripts/import/go.scm (guix-import-go): Conditionally include the version in the package symbols defined. Maxim Cournoyer
2021-04-09doc: Quote a URL to avoid misinterpretation by the shell....Otherwise, the shell tries to perform pattern-matching based on the "?" character. Reported by nij in #guix. * doc/guix.texi (Binary Installation): Add quotes around OPENPGP-SIGNING-KEY-URL. Leo Famulari
2021-04-09services: Add Laminar....* gnu/services/ci.scm: New file. * gnu/tests/ci.scm: New file. * doc/guix.texi (Laminar): Document the Laminar service. Christopher Baines
2021-04-06gnu-maintenance: Add 'sourceforge' updater....This updater currently covers 2.4% of the packages. * guix/gnu-maintenance.scm (latest-sourceforge-release): New procedure. (%sourceforge-updater): New variable. * doc/guix.texi (Invoking guix refresh): Document it. Ludovic Courtès
2021-04-05doc: Use the shell dollar substitution....See: https://unix.stackexchange.com/questions/126927/have-backticks-i-e-cmd-in-sh-shells-been-deprecated * doc/guix.texi: Replace the shell backquote deprecated substitution by the dollar one. zimoun
2021-04-05doc: Reorder "Channels with Substitutes"....Ordering consistency introduced by 12871cc8db701a89f7f64303e1f16a8537a12561. * doc/guix.texi (Channels): Move section "Channels with Substitutes". Update the master menu. zimoun
2021-04-03services: guix-publish: Add zstd compression by default....That way, the default config with (advertises? #t) and without a cache will offer zstd-compressed substitutes, which should lead to much higher throughput than gzip. * gnu/services/base.scm (default-compression): When 'guix-publish-configuration-cache' returns true, use higher level compression ratios. Add "zstd". * doc/guix.texi (Base Services): Mention zstd. Ludovic Courtès
2021-04-01doc: Fix typo....* doc/guix.texi (Inferiors): Use past tense. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Xinglu Chen
2021-04-01doc: Discourage ambiguous package names....* doc/contributing.texi (Package Naming): Explicitly mention single-character and otherwise ambiguous names. Tobias Geerinckx-Rice via Bug reports for GNU Guix
2021-04-01services: kmscon: Add font-engine and font-size fields....* gnu/services/base.scm (<kmscon-configuration>): Add font-engine and font-size fields. (kmscon-service-type): Honor them. * doc/guix.texi (Base Services): Document them. qblade
2021-03-31doc: Fix a typo in the Julia build system section....* doc/guix.texi (julia-build-system): Fix typo. Leo Famulari
2021-03-31status: Don't display download URLs for '--verbosity=1'....With this change, each substitute occupies a single line of output (instead of two) when using '-v1', the default for 'guix package' & co. * guix/status.scm (print-build-event): Add #:print-urls? and honor it. (print-build-event/quiet): Pass #:print-urls? #f. (print-build-event/quiet-with-urls): New procedure. (logger-for-level): Add case for LEVEL 2. * doc/guix.texi (Common Build Options): Adjust '--verbosity' documentation. Ludovic Courtès
2021-03-30doc: Document powerpc64le-linux support....* doc/guix.texi (GNU Distribution): Document support for powerpc64le-linux as a "technology preview." Chris Marusich
2021-03-26doc: "Invoking guix refresh" links to '--with-latest'....* doc/guix.texi (Invoking guix refresh): Reword intro and Link to '--with-latest'. Ludovic Courtès
2021-03-26doc: Explain how to pass 'guix refresh' the packages found in your profile....Suggested by Xinglu Chen <public@yoctocell.xyz>. * doc/guix.texi (Invoking guix refresh): Mention how to update packages found in one's profile. Ludovic Courtès
2021-03-26doc: Move 'guix refresh --list-updaters' reference to the right place....* doc/guix.texi (Invoking guix refresh): Move '--list-updaters' right after '--type'. Ludovic Courtès
2021-03-24doc: Fix typo in qemu-binfmt-service example....* doc/guix.texi (Virtualization Services): Add missing parentheses. Leo Famulari
2021-03-23doc: cuirass: Update documentation....* doc/guix.texi (Continuous Integration): Update Cuirass documentation. Mathieu Othacehe
2021-03-23doc: Remove Simple Cuirass section....This is no longer needed as the Cuirass specification mechanism has been rewritten. * doc/guix.texi (Continuous Integration): Remove Simple Cuirass section. Mathieu Othacehe
2021-03-20gnu: Add julia-jllwrappers....* gnu/packages/julia-xyz.scm (julia-jllwrappers): New variable. * doc/guix.texi (julia-build-system): Document how to use jllwrappers to use to guix binary packages. Co-authored-by: Ludovic Courtès <ludo@gnu.org> nixo
2021-03-20doc: Fix typo in julia-build-system....* doc/guix.texi (julia-build-system): replace argument wrongly named julia-file-name with the correct julia-package-name. Signed-off-by: Ludovic Courtès <ludo@gnu.org> nixo
2021-03-20doc: Fix syntax of '.guix-channel' dependency example....Reported by ison <ison@airmail.cc>. * doc/guix.texi (Declaring Channel Dependencies): Remove quote in 'dependencies' example. Ludovic Courtès
2021-03-19doc: Add 'shepherd-service' example....* doc/guix.texi (Shepherd Services): Add example. Ludovic Courtès
2021-03-18services: Enable "protected hardlinks" and "protected symlinks" by default....References: https://sysctl-explorer.net/fs/protected_hardlinks/ https://sysctl-explorer.net/fs/protected_symlinks/ * gnu/services/sysctl.scm (%default-sysctl-settings): New public variable. (<sysctl-configuration>): Use %default-sysctl-settings as the default value. * gnu/services/base.scm (%base-services): Add sysctl-service-type. * doc/guix.texi (Miscellaneous Services): Document the new defaults. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Leo Famulari
2021-03-17doc: Tweak "Invoking guix refresh" node....* doc/guix.texi (Invoking guix refresh): Update output in '--recursive' example. Use @xref, not @ref, at the beginning of a sentence. Ludovic Courtès
2021-03-17gnu-maintenance: Add 'generic-html' updater....This brings total updater coverage, as reported by 'guix refresh --list-updaters', from 78% to 88.3%. Among many other things, it covers freedesktop.org packages. * guix/gnu-maintenance.scm (html-updatable-package?) (latest-html-updatable-release): New procedures. (%generic-html-updater): New variable. * doc/guix.texi (Invoking guix refresh): Document it. Ludovic Courtès
2021-03-17gnu-maintenance: Use (htmlprag) for 'latest-html-release'....* guix/gnu-maintenance.scm (html->sxml): Remove. Autoload (htmlprag) instead. * doc/guix.texi (Requirements): Mention 'guix refresh' for the Guile-Lib dependency. Ludovic Courtès
2021-03-17doc: Define the term "profile"....Fixes <https://bugs.gnu.org/46803>. Reported by Luis Felipe <luis.felipe.la@protonmail.com>. * doc/guix.texi (Getting Started): Introduce the term "profile". (Invoking guix package): Likewise. Ludovic Courtès