summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)Author
2022-02-15doc: Move build commands to @example for clarity.Ludovic Courtès
* doc/contributing.texi (Building from Git): Tweak so that all the commands appear in @example boxes. Show --localstatedir=/var instead of --localstatedir=@var{directory}.
2022-02-15doc: Clarify the Swap Space examples, and include an helper example.Josselin Poiret
* doc/guix.texi (Swap Space): The examples referred to variables defined outside of the snippets, and so were not very informative for people without much Guile knowledge. Instead, refer to mapped-devices for the first, and use the new helper file-systme-mount-point-predicate for the second. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-02-14pull: '--list-generations' lists packages only with '--details'.Ludovic Courtès
* guix/scripts/pull.scm (show-help, %options): Add "--details". (process-query): Honor it. * doc/guix.texi (Invoking guix pull): Document it.
2022-02-14git-authenticate: Ensure the target is a descendant of the introductory commit.Ludovic Courtès
Fixes a bug whereby authentication of a commit *not* descending from the introductory commit could succeed, provided the commit verifies the authorization invariant. In the example below, A is a common ancestor of the introductory commit I and of commit X. Authentication of X would succeed, even though it is not a descendant of I, as long as X is authorized according to the '.guix-authorizations' in A: X I \ / A This is because, 'authenticate-repository' would not check whether X descends from I, and the call (commit-difference X I) would return X. In practice that only affects forks because it means that ancestors of the introductory commit already contain a '.guix-authorizations' file. * guix/git-authenticate.scm (authenticate-repository): Add call to 'commit-descendant?'. * tests/channels.scm ("authenticate-channel, not a descendant of introductory commit"): New test. * tests/git-authenticate.scm ("authenticate-repository, target not a descendant of intro"): New test. * tests/guix-git-authenticate.sh: Expect earlier test to fail since 9549f0283a78fe36f2d4ff2a04ef8ad6b0c02604 is not a descendant of $intro_commit. Add new test targeting an ancestor of the introductory commit, and another test targeting the v1.2.0 commit. * doc/guix.texi (Specifying Channel Authorizations): Add a sentence.
2022-02-13doc: Zabbix: Improvide description.Marius Bakke
* doc/guix.texi (Monitoring Services): Document the various 'zabbix-*' service types, and expand description of all Zabbix services. Use less marketing terms. (Web Services): Add subsubheading for PHP-FPM, and anchors for cross-referencing. * gnu/services/monitoring.scm (zabbix-front-end-configuration): Use @ref instead of @pxref for cross-referencing.
2022-02-07doc: Regenerate Zabbix server and agent configuration.Marius Bakke
...to make them in line with the newly generated front-end documentation. * doc/guix.texi (Monitoring Services): Regenerate zabbix-server-configuration and zabbix-agent-configuration.
2022-02-07services: zabbix-front-end: Restore backwards compatibility.Marius Bakke
Commit e301f1a8ed11f9eacb2b7f525a7446dc00621a8b removed the NGINX argument entirely, but users may rely on and override it. Reported by rekado on #guix. * gnu/services/monitoring.scm (%zabbix-front-end-nginx-configuration): Restore exported variable. (zabbix-front-end-nginx-extension): New procedure. (zabbix-front-end-configuration): Remove FASTCGI-PARAMS field. Restore NGINX field, but default to the empty list. (zabbix-front-end-service-type): Extend NGINX-SERVICE-TYPE by ZABBIX-FRONT-END-NGINX-EXTENSION. * doc/guix.texi (Monitoring Services): Regenerate documentation.
2022-02-07home: Add redshift service.Ludovic Courtès
* gnu/home/services/desktop.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (Desktop Home Services): New node.
2022-02-04nls: Update translations.Julien Lepiller
* po/doc/guix-cookbook.pt_BR.po: New file. * po/doc/local.mk: Add it. * doc/local.mk: Add pt_BR cookbook.
2022-02-04services: nar-herder: Support ttl and negative-ttl options.Christopher Baines
* gnu/services/guix.scm (<nar-herder-configuration>): Add ttl and negative-ttl fields. (nar-herder-shepherd-services): Pass the ttl and negative-ttl values to the service. * doc/guix.texi (Guix Services): Document this.
2022-02-02deploy: Add '--execute'.Ludovic Courtès
* guix/scripts/deploy.scm (show-help, %options): Add '--execute'. (invoke-command): New procedure. (guix-deploy): Break arguments at "--" and handle '-x' and associated command. * doc/guix.texi (Invoking guix deploy): Document it.
2022-02-02guix system: 'describe' shows the running system, not the current one.Ludovic Courtès
* guix/profiles.scm (generation-number): Add optional 'base-profile' parameter and use it. * guix/scripts/system.scm (process-command): Add "/run/current-system" as first argument to 'generation-number'. * doc/guix.texi (Invoking guix system): Clarify that 'guix system describe' shows the running system.
2022-02-02services: tlp: Add config variables for battery charging.Attila Lendvai
* gnu/services/pm.scm (tlp-configuration): Add start-charge-thresh-bat0, stop-charge-thresh-bat0, start-charge-thresh-bat1, stop-charge-thresh-bat1. * doc/guix.texi (Power Management Services): Document them. Signed-off-by: Ricardo Wurmus <rekado@elephly.net>
2022-02-01services: zabbix-frontend: Support custom server package.Marius Bakke
* gnu/services/monitoring.scm (%zabbix-front-end-configuration-nginx): Rename to ... (zabbix-front-end-nginx-configuration): ... this. Take server package and FastCGI parameters from ... (zabbix-front-end-configuration): ... here. Add PACKAGE and FASTCGI-PARAMS fields, remove NGINX. (zabbix-front-end-service-type): Adjust for renamed procedure. * doc/guix.texi (Monitoring Services)[Zabbix front-end]: Regenerate documentation.
2022-02-01doc: Fix typo.Maxim Cournoyer
* doc/guix.texi (Sound Services): Fix typo.
2022-01-31doc: Add a rule of thumb to guide enabling new committers.Maxim Cournoyer
* doc/contributing.texi (Commit Access): Introduce a new rule of thumb to determine if a contributor should be considered to become a committer.
2022-02-01doc: Document --profile option to "guix environment"Konrad Hinsen
* doc/guix.texi (Invoking guix environment): New paragraph. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-02-01doc: Document --profile option to "guix shell"Konrad Hinsen
* doc/guix.texi (Invoking guix shell): New paragraph. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2022-01-31services: guix: Add nar-herder-service-type.Christopher Baines
* gnu/services/guix.scm (<nar-herder-configuration>): New record type. (nar-herder-configuration, nar-herder-configuration?, nar-herder-configuration-package, nar-herder-configuration-user, nar-herder-configuration-group, nar-herder-configuration-mirror nar-herder-configuration-database nar-herder-configuration-database-dump nar-herder-configuration-host nar-herder-configuration-port nar-herder-configuration-storage nar-herder-configuration-storage-limit nar-herder-configuration-storage-nar-removal-criteria nar-herder-shepherd-services, nar-herder-activation, nar-herder-account): New procedures. (nar-herder-service-type): New variable. * gnu/tests/guix.scm (%test-nar-herder): New variable. * doc/guix.texi (Guix Services): Document the new service.
2022-01-28home: 'reconfigure' checks for potential downgrades.Ludovic Courtès
* guix/scripts/home.scm (show-help, %options): Add "--allow-downgrades". (%default-options): Remove 'build-mode'; add 'validate-reconfigure'. (perform-action): Add #:validate-reconfigure. Call 'check-forward-update' when ACTION is 'reconfigure. (process-action): Pass #:validate-reconfigure to 'perform-action'. * gnu/home/services.scm (home-provenance): Export. * doc/guix.texi (Invoking guix home): Document '--allow-downgrades'.
2022-01-28doc: Mention how to remedy "source file ... newer than compiled error".Guix Together
* doc/contributing.texi (Running Guix Before It Is Installed): Mention how to remedy "source file ... newer than compiled" error by running `make -j`. Co-authored-by: jgart <jgart@dismail.de> Co-authored-by: Julien Lepiller <julien@lepiller.eu> Co-authored-by: Ryan Prior <rprior@protonmail.com> Co-authored-by: Blake Shaw <blake@nonconstructivism.com> Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr>
2022-01-28doc: Explain the use of make clean-go when an ABI mismatch occurs.Guix Together
* doc/contributing.texi (Building from Git): Adds section on using make clean-go. Co-authored-by: jgart <jgart@dismail.de> Co-authored-by: Julien Lepiller <julien@lepiller.eu> Co-authored-by: Ryan Prior <rprior@protonmail.com> Co-authored-by: Blake Shaw <blake@nonconstructivism.com> Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr>
2022-01-25doc: Document 'invoke' & co.Ludovic Courtès
* doc/guix.texi (Build Utilities)[Program Invocation]: New subsection.
2022-01-25build: Require Guile >= 3.0.3.Ludovic Courtès
Fixes <https://issues.guix.gnu.org/53157>. Reported by Efraim Flashner <efraim@flashner.co.il>. * configure.ac: Require Guile >= 3.0.3. * doc/guix.texi (Requirements): Update accordingly.
2022-01-24doc: Clarify search path bits.Ludovic Courtès
Suggested by Maxime Devos <maximedevos@telenet.be> and Maxim Cournoyer <maxim.cournoyer@gmail.com>. * doc/guix.texi (package Reference): Clarify 'native-search-paths' vs. 'search-paths'. (Search Paths): Link to it. Remove unnecessarily "define libxml2". Reword 'file-pattern' description that said "When true".
2022-01-23doc: Tweak Guix Home bits.Ludovic Courtès
* doc/guix.texi (Shepherd Home Service): Tweak section name. Add intro. (Invoking guix home): Refer to "guix search". Use @var where appropriate.
2022-01-23doc: Document search paths.Ludovic Courtès
* doc/guix.texi (package Reference): Link to "Search Paths". (Invoking guix package): Likewise. (Build Phases): Mention 'set-paths' phase. (Search Paths): New node.
2022-01-20services: guix-publish: Add negative-ttl parameter.Guillaume Le Vaillant
* gnu/services/base.scm (guix-publish-configuration): Add 'negative-ttl' field. (guix-publish-sheperd-service): Process it. * doc/guix.texi (Base Services)[guix-publish-service-type]: Add item for negative-ttl.
2022-01-19doc: Normalize language codes in menu URLs.Ludovic Courtès
* doc/build.scm (stylized-html)[build](base-language-url): Add calls to 'normalize'.
2022-01-19doc: Make the HTML language menu disappear on narrow screens.Ludovic Courtès
* doc/build.scm (stylized-html)[build](navigation-bar): New procedure. (stylized-html): Use it.
2022-01-18doc: Add a language menu in the HTML manual.Ludovic Courtès
* doc/build.scm (stylized-html): New procedure. (html-manual): Use it.
2022-01-18doc: Factorize 'language-code->native-name'.Ludovic Courtès
* doc/build.scm (localization-helper-module)[content](translate): Add call to 'setenv' before 'write'. Remove use of 'with-language'. (language-code->native-name): New procedure. (html-manual-indexes)[build](top-level-index): Use it.
2022-01-18daemon: Always default to gzip for log compression.Ludovic Courtès
* nix/libstore/globals.cc (Settings::Settings): Have 'logCompression' default to COMPRESSION_GZIP unconditionally. * gnu/services/base.scm (<guix-configuration>)[log-compression]: Default to 'gzip. * doc/guix.texi (Invoking guix-daemon, Base Services): Adjust accordingly.
2022-01-18doc: Extract (localization) module.Ludovic Courtès
* doc/build.scm (localization-helper-module): New procedure. (html-manual-indexes)[build]: Use it. Remove use of GUILE-JSON-3.
2022-01-16machine: ssh: Add 'safety-checks?' field.Ludovic Courtès
Fixes <https://issues.guix.gnu.org/52766>. Reported by Michael Rohleder <mike@rohleder.de>. * gnu/machine/ssh.scm (<machine-ssh-configuration>)[safety-checks?]: New field. (machine-check-file-system-availability): Return the empty list when 'safety-checks?' is false. (machine-check-initrd-modules): Likewise. * doc/guix.texi (Invoking guix deploy): Document it.
2022-01-16doc: Fix typo.Leo Famulari
Groan. * doc/guix.texi (Build Environment Setup): Fix typo.
2022-01-16doc: Document the dummy $HOME in the build chroot.Leo Famulari
This missing documentation reported by Matt <matt@excalamus.com>. * doc/guix.texi (Build Environment Setup): Document '/homeless-shelter'.
2022-01-15doc: Remove now unnecessary workaround.Ludovic Courtès
* doc/build.scm (translated-texi-manuals): Turn into an alias for (@@ (guix self) translated-texi-manuals).
2022-01-14doc: Update "guix shell -D -f" example to new input style.Ludovic Courtès
* doc/environment-gdb.scm: Change to use 'modify-inputs'.
2022-01-14scripts: system: Rationalize persistency.Mathieu Othacehe
Make sure that the images are created with a non volatile root by default and the vm are created with a volatile root by default. Break the --volatile option into --volatile-image and --persistent-vm options. * guix/scripts/system.scm (perform-action): Turn volatile? argument into volatile-vm-root?. (show-help): Introduce --volatile-image and --persistent-vm options instead of --volatile. (%default-options): Adapt it. (%options): Handle those options. (process-action): Honor them. * doc/guix.texi (Invoking guix system): Adapt it accordingly.
2022-01-14gnu: bootstrap: Add support for riscv64-linux.Efraim Flashner
On 7d93b21ab1c132990054372a9677c1639d54e631 gnu: glibc-for-bootstrap: Update patch. Run ./pre-inst-env guix build --target=riscv64-linux-gnu bootstrap-tarballs Producing /gnu/store/4hdzva9i0wyyfbgj1lmqc1wkk644pv07-bootstrap-tarballs-0 With guix hash -rx 1nj0fdgj08bbmfny01mp2blv7c3p2iciqh31zmf04ap5s7ygsqlp * gnu/packages/bootstrap.scm (%bootstrap-executables): Add entries for riscv64-linux. (%bootstrap-guile-hash, %bootstrap-coreutils&co, %bootstrap-binutils, %bootstrap-glibc, %bootstrap-gcc): Add entry for riscv64-linux. (raw-build-guile3): New procedure. (make-raw-bag): Use raw-build-guile3 for riscv64-linux. * guix/packages.scm (%supported-systems): Add riscv64-linux. (%cuirass-supported-systems): Remove riscv64-linux. * guix/utils.scm (target-64bit?): Add riscv64-linux. * m4/guix.m4: Add riscv64-linux as a supported system. * doc/guix.texi (GNU Distribution): Add riscv64-linux.
2022-01-13services: Adjust the jami service for the upgraded jami.Maxim Cournoyer
* gnu/services/telephony.scm (jami-configuration)[jamid]: Rename libring to libjami. * gnu/services/telephony.scm (jami-configuration->command-line-arguments): Adjust daemon file name. * gnu/services/telephony.scm (jami-service-type): Adjust doc. * gnu/tests/telephony.scm (run-jami-test): Check for 'jamid' process, not 'dring'. * doc/guix.texi (Telephony Services): Adjust doc for the jami-qt to jami and libring to libjami packages renaming.
2022-01-11shell: Cache profiles even when using package specs.Ludovic Courtès
This enables profile caching not just when '-m' or '-f' is used, but also when package specs are passed on the command line, as in: guix shell -D guix git It also changes profile cache keys to include the system type, which was previously ignored. * guix/scripts/shell.scm (options-with-caching)[single-file-for-caching]: Remove. Call 'profile-cached-gc-root' instead; adjust to accept two values. (profile-cache-primary-key): New procedure. (profile-cache-key): Remove. (profile-file-cache-key, profile-spec-cache-key): New procedures. (profile-cached-gc-root): Rewrite to include functionality formally in 'single-file-for-caching', but extend to handle package specs. * gnu/packages.scm (cache-is-authoritative?): Export. * guix/transformations.scm (transformation-option-key?): New procedure. * doc/guix.texi (Invoking guix shell): Move '--rebuild-cache' documentation to the bottom, just above '--root'. Explain caching and how these two options relate to that.
2022-01-11doc: Fix typo in 'setuid-program' example.Ludovic Courtès
* doc/guix.texi (Setuid Programs): Fix typo in example.
2022-01-09doc: Update ‘guix home search’ output sample.Tobias Geerinckx-Rice
The old output differs greatly from the current one and contains a typo. * doc/guix.texi (Invoking guix home): Update ‘guix home search’ output sample.
2022-01-09doc: Fix typos.Tobias Geerinckx-Rice
* doc/guix.texi (Home Services, Essential Home Services) (Shells Home Services): Fix ‘avaliable’ typo, & grammar. (Using the Configuration System): Fix another typo.
2022-01-10doc: Use @lisp and clarify 'setuid-program' examples.Ludovic Courtès
* doc/guix.texi (Setuid Programs): Use @lisp instead of @example. Add scope for the 'setuid-programs' field snippet.
2022-01-10guix hash: Allow '-r' as a non-deprecated alias.Ludovic Courtès
This is a followup to 05c962594c346da21f201be72caadfa19060cc9d. Discussed at <https://issues.guix.gnu.org/51307#24>. * guix/scripts/hash.scm (%options): Warn about deprecation for "--recursive", but not for '-r' as it's a convenient shorthand. Mention '--serializer=nar' in the deprecation message. * doc/guix.texi (Invoking guix hash): Adjust accordingly.
2022-01-10doc: Fix typo.Ludovic Courtès
* doc/guix.texi (Invoking guix style): Fix typo.
2022-01-10style: Add '--styling' option.Ludovic Courtès
* guix/scripts/style.scm (format-package-definition): New procedure. (%options, show-help): Add "--styling". (%default-options): Add 'styling-procedure'. (guix-style): Honor it. * tests/style.scm (with-test-package) ("input labels, 'safe' policy") ("input labels, 'safe' policy, nothing changed") ("input labels, margin comment") ("input labels, margin comment on long list") ("input labels, line comment") ("input labels, modify-inputs and margin comment"): Pass "-S inputs". * etc/indent-code.el: Remove. * doc/contributing.texi (Formatting Code): Mention "guix style" instead of "etc/indent-code.el". (Submitting Patches): Add item for "guix style". * doc/guix.texi (Invoking guix style): Document "-S" and update.
generated by cgit-pink 1.4.1 (git 2.36.1) at 2024-11-29 14:32:14 +0000