summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)Author
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'.
2021-04-18nls: Add Italian translation.Julien Lepiller
* po/doc/guix-manual.it.po: New file. * po/doc/local.mk (DOC_PO_FILES): Add it. * doc/local.mk (info_TEXINFOS): Add it. * po/guix/it.po: New file. * po/guix/LINGUAS: Add 'it'.
2021-04-18nls: Add Persian translation.Julien Lepiller
* po/packages/fa.po: New file. * po/packages/LINGUAS: Add 'fa'. * po/doc/guix-cookbook.fa.po: New file. * po/doc/guix-manual.fa.po: New file. * po/doc/local.mk (DOC_PO_FILES, DOC_COOKBOOK_PO_FILES): Add them. * doc/local.mk (info_TEXINFOS): Add them.
2021-04-18nls: Add Slovak translation.Julien Lepiller
* po/packages/sk.po: New file. * po/packages/LINGUAS: Add 'sk'. * po/doc/guix-manual.sk.po: New file. * doc/local.mk (info_TEXINFOS): Add it. * po/doc/local.mk (DOC_PO_FILES): Add it.
2021-04-18nls: Add Portuguese (Brazil) translation of the manual.Julien Lepiller
2021-04-18nls: Add French translation of the cookbook.Julien Lepiller
2021-04-18doc: Fix pxref translation issue.Julien Lepiller
* doc/local.mk (xref_command): Change regexp to match properly.
2021-04-14git: Honor proxy settings when fetching submodules.Ludovic Courtès
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.
2021-04-14Revert "services: mysql: Add extra-environment as configuration option."Leo Prikler
This reverts commit f3626119d738f30b5ab59e76c105fd7b4c077ddc. This commit inadvertently broke a string freeze. Let's be nice to our translators and not do that.
2021-04-13services: 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-12services: postgresql: Change service default socket directory.Christopher Baines
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>
2021-04-12doc: Document 'gnu-build-system' keyword parameters.Ludovic Courtès
* doc/guix.texi (Build Systems): Document keyword parameters of 'gnu-build-system'.
2021-04-12doc: Move list of build phases to "Build Phases".Ludovic Courtès
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.
2021-04-12services: Add ipfs-service-typeMaxime Devos
* 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>
2021-04-12services: Support DELETE in MODIFY-SERVICES macro.Ricardo Wurmus
* 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.
2021-04-11doc: Fix connect to the VM over SSH example.Oleg Pykhalov
* doc/guix.texi (Running Guix in a VM): Add host which connect to in SSH connection example.
2021-04-10doc: Fix typos.Tobias Geerinckx-Rice
* 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.
2021-04-09import: go: Append version to symbol name in the pinned version mode.Maxim Cournoyer
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.
2021-04-09doc: Quote a URL to avoid misinterpretation by the shell.Leo Famulari
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.
2021-04-09services: Add Laminar.Christopher Baines
* gnu/services/ci.scm: New file. * gnu/tests/ci.scm: New file. * doc/guix.texi (Laminar): Document the Laminar service.
2021-04-06gnu-maintenance: Add 'sourceforge' updater.Ludovic Courtès
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.
2021-04-05doc: Use the shell dollar substitution.zimoun
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.
2021-04-05doc: Reorder "Channels with Substitutes".zimoun
Ordering consistency introduced by 12871cc8db701a89f7f64303e1f16a8537a12561. * doc/guix.texi (Channels): Move section "Channels with Substitutes". Update the master menu.
2021-04-04doc: Remind developers to build Guix.Leo Famulari
The previous instructions were correct, but we got too many bug reports with a root cause of "did not build Guix yet". Other parts of the manual already instruct `make && make check`, so this makes the treatment of building Guix more consistent, too. * doc/contributing.texi (Building from Git): Instruct the user to run `make` when building Guix.
2021-04-03services: guix-publish: Add zstd compression by default.Ludovic Courtès
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.
2021-04-01doc: Fix typo.Xinglu Chen
* doc/guix.texi (Inferiors): Use past tense. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-04-01doc: Discourage ambiguous package names.Tobias Geerinckx-Rice via Bug reports for GNU Guix
* doc/contributing.texi (Package Naming): Explicitly mention single-character and otherwise ambiguous names.
2021-04-01services: kmscon: Add font-engine and font-size fields.qblade
* 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.
2021-03-31doc: Fix a typo in the Julia build system section.Leo Famulari
* doc/guix.texi (julia-build-system): Fix typo.
2021-03-31status: Don't display download URLs for '--verbosity=1'.Ludovic Courtès
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.
2021-03-30doc: Document powerpc64le-linux support.Chris Marusich
* doc/guix.texi (GNU Distribution): Document support for powerpc64le-linux as a "technology preview."
2021-03-26doc: "Invoking guix refresh" links to '--with-latest'.Ludovic Courtès
* doc/guix.texi (Invoking guix refresh): Reword intro and Link to '--with-latest'.
2021-03-26doc: Explain how to pass 'guix refresh' the packages found in your profile.Ludovic Courtès
Suggested by Xinglu Chen <public@yoctocell.xyz>. * doc/guix.texi (Invoking guix refresh): Mention how to update packages found in one's profile.
2021-03-26doc: Move 'guix refresh --list-updaters' reference to the right place.Ludovic Courtès
* doc/guix.texi (Invoking guix refresh): Move '--list-updaters' right after '--type'.
2021-03-24doc: Fix typo in qemu-binfmt-service example.Leo Famulari
* doc/guix.texi (Virtualization Services): Add missing parentheses.
2021-03-23doc: cuirass: Update documentation.Mathieu Othacehe
* doc/guix.texi (Continuous Integration): Update Cuirass documentation.
2021-03-23doc: Remove Simple Cuirass section.Mathieu Othacehe
This is no longer needed as the Cuirass specification mechanism has been rewritten. * doc/guix.texi (Continuous Integration): Remove Simple Cuirass section.
2021-03-20gnu: Add julia-jllwrappers.nixo
* 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>
2021-03-20doc: Fix typo in julia-build-system.nixo
* 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>
2021-03-20doc: Fix syntax of '.guix-channel' dependency example.Ludovic Courtès
Reported by ison <ison@airmail.cc>. * doc/guix.texi (Declaring Channel Dependencies): Remove quote in 'dependencies' example.
2021-03-20doc: Remove the guile-lib/htmlprag-fixed package.Maxim Cournoyer
This hotfix package is no longer necessary as the ability to parameterize the way htmlprag tokenizes HTML was added in guile-lib 0.2.7. * doc/build.scm (guile-lib/htmlprag-fixed): Remove variable. (html-manual-identifier-index): Replace guile-lib/htmlprag-fixed by guile-lib, and make set the %strict-tokenizer? parameter to #t. (syntax-highlighted-html): Likewise.
2021-03-19doc: Add 'shepherd-service' example.Ludovic Courtès
* doc/guix.texi (Shepherd Services): Add example.
2021-03-18doc: Document the guidelines for removing inactive committers.Leo Famulari
For more context, see the discussion in <https://bugs.gnu.org/47111>. * doc/contributing.texi (Commit Access): Add paragraph about removing inactive committers.
2021-03-18services: Enable "protected hardlinks" and "protected symlinks" by default.Leo Famulari
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>
2021-03-17doc: Tweak "Invoking guix refresh" node.Ludovic Courtès
* doc/guix.texi (Invoking guix refresh): Update output in '--recursive' example. Use @xref, not @ref, at the beginning of a sentence.