summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)Author
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.
2022-01-10build: julia-build-system: Create 'Project.toml' file when missing.zimoun
* guix/build/julia-build-system.scm (link-depot): Create 'Project.toml' file when missing using data provided by the user. (julia-create-package-toml): Remove from export. * doc/guix.texi (Build Systems): Update julia-build-system section. Signed-off-by: Efraim Flashner <efraim@flashner.co.il>
2022-01-10doc: Fix some typos.Tobias Geerinckx-Rice
* doc/guix.texi (Invoking guix hash): Fix a few typos today. Reported by KarlJoad on #guix, and then we found more.
2022-01-09nls: Update translations.Julien Lepiller
* po/doc/guix-cookbook.fi.po: New file. * po/doc/guix-manual.fi.po: New file. * po/doc/local.mk: Add them. * doc/local.mk: Add them. * po/guix/fi.po: New file. * po/guix/LINGUAS: Add it.
2022-01-07doc: Fix typo.Jelle Licht
* doc/guix.texi (Essential Home Services): Fix typo.
2022-01-07doc: Use a better setuid example.Tobias Geerinckx-Rice
nmtui does not benefit from being setuid. Oops. * doc/guix.texi (Setuid Programs): Replace network-manager's /bin/nmtui with nfs-utils' /sbin/mount.nfs. Change a @code{} to a @command{}.
2022-01-06doc: Fix typo.Tobias Geerinckx-Rice
* doc/guix.texi (Build Utilities): Fix typo. Reported by Mortimer Cladwell <mbcladwell@gmail.com>
2022-01-03doc: Try to clarify the setuid programs examples.Leo Famulari
Based on user feedback, the shadow / passwd example was too obscure for those who aren't familiar with the shadow collection of tools. And it was also considered confusing for the two examples to use different packages. * doc/guix.texi (Setuid Programs): Use 'nmtui' in the examples.
2022-01-03doc: Avoid (getenv "HOME") in 'machines.scm' example.Ludovic Courtès
Fixes <https://issues.guix.gnu.org/52517>. Reported by zimoun <zimon.toutoune@gmail.com>. * doc/guix.texi (Daemon Offload Setup): Avoid misleading (getenv "HOME") in example.
2022-01-03doc: Document clauses of 'modify-inputs'.Ludovic Courtès
Suggested by Alexander Asteroth <alexander.asteroth@h-brs.de>. * doc/guix.texi (Defining Package Variants): Document all the supported clauses of 'modify-inputs'.
2022-01-02services: guix-build-coordinator: Fix variable name in agent config.Christopher Baines
* gnu/services/guix.scm (<guix-build-coordinator-agent-configuration>): Fix variable name. * doc/guix.texi (Guix Services): Update accordingly.
2022-01-02gnu: Add guix-build-coordinator/agent-only.Christopher Baines
This avoids issues where the coordinator component dependencies (like sqitch and guile-fibers) make it harder to use the agent. * gnu/packages/package-management.scm (guix-build-coordinator/agent-only): New variable. * gnu/services/guix.scm (<guix-build-coordinator-agent-configuration>): Use the guix-build-coordinator/agent-only package by default. * doc/guix.texi (Guix Services): Update accordingly.
2022-01-01transformations: Add '--tune'.Ludovic Courtès
* guix/transformations.scm (tuning-compiler) (tuned-package, tunable-package?, package-tuning) (transform-package-tuning) (build-system-with-tuning-compiler): New procedures. (%transformations): Add 'tune'. (%transformation-options): Add "--tune". * tests/transformations.scm ("options->transformation, tune") ("options->transformations, tune, wrong micro-architecture"): New tests. * doc/guix.texi (Package Transformation Options): Document '--tune'.
2022-01-01system: Allow 'chfn' to change the user's full name.Ludovic Courtès
Fixes <https://issues.guix.gnu.org/52539>. Reported by Jacob First <jacob.first@member.fsf.org>. * gnu/build/accounts.scm (allocate-passwd): Add comment as to why 'real-name' is taken from PREVIOUS. Add (not system?) to the condition. * gnu/system.scm (operating-system-etc-service) <login.defs>: Add "CHFN_RESTRICT". * gnu/system.scm (%setuid-programs): Add "chfn". * gnu/system/pam.scm (base-pam-services): Add "chfn". * doc/guix.texi (User Accounts): Document it.
2021-12-30doc: cookbook: Update custom kernel guide.Leo Famulari
* doc/guix-cookbook.texi (Customizing the Kernel): Adjust to new interface.
2021-12-26doc: Give a complete example of adding setuid programs.Leo Famulari
* doc/guix.texi (Setuid Programs): Give a complete example of how to use SETUID-PROGRAM.
2021-12-23scripts: system: Deprecate the docker-image command.Mathieu Othacehe
* guix/scripts/system.scm (system-derivation-for-action): Use the image API to generate the docker images and deprecate the docker-image command. (process-action): Ditto. * doc/guix.texi (Invoking guix system): Adapt it.
2021-12-23Remove VM generation dead-code.Mathieu Othacehe
This code duplicates the (gnu system image) and (gnu build image) code. Using VM for image generation is not needed, not portable and really slow. Remove all the VM image generation code to make sure that only the image API is used. * gnu/build/vm.scm: Remove it. Move the qemu-command procedure to ... * gnu/build/marionette.scm: ... here. * gnu/local.mk (GNU_SYSTEM_MODULES): Adapt it. * tests/modules.scm: Ditto. * gnu/tests/install.scm: Ditto. * gnu/system/vm.scm: Adapt it and remove expression->derivation-in-linux-vm, qemu-img, system-qemu-image/shared-store and system-docker-image procedures. * doc/guix.texi (G-Expressions): Adapt it.
2021-12-22doc: Document (gnu services configuration).Xinglu Chen
* guix.texi (Complex Configurations): New node. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-12-22services: wireguard: Add DNS config field.Nathan Dehnel
* gnu/services/vpn.scm (wireguard-configuration)[dns]: New field. (wireguard-configuration-file): Honor it. * doc/guix.texi: Document it. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-12-21services: rsync: Allow configuring several rsync "modules".Ludovic Courtès
Until now the rsync service would export a single module, named "files". This allows users to specify as many modules as they want, in line with rsyncd.conf(5). * gnu/services/rsync.scm (warn-share-field-deprecation): New procedure. (<rsync-configuration>)[modules]: New field. [share-path, share-comment, read-only?, timeout]: Mark as deprecated. (<rsync-module>): New record type. (%default-modules): New variable. (rsync-configuration-modules): New procedure. (rsync-activation): Create the directory of each module. (rsync-config-file): Generate configuration for each module. (rsync-service-type)[description]: New field. * doc/guix.texi (Networking Services): Adjust documentation. Augment example.