summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Expand)Author
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-04doc: Remind developers to build Guix....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. Leo Famulari
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-20doc: Remove the guile-lib/htmlprag-fixed package....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. Maxim Cournoyer
2021-03-19doc: Add 'shepherd-service' example....* doc/guix.texi (Shepherd Services): Add example. Ludovic Courtès
2021-03-18doc: Document the guidelines for removing inactive committers....For more context, see the discussion in <https://bugs.gnu.org/47111>. * doc/contributing.texi (Commit Access): Add paragraph about removing inactive committers. Leo Famulari
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
2021-03-16gnu: Remove MongoDB....mongodb 3.4.10 has unpatched CVEs and mongodb 3.4.24 has some files in the release tarball under the SSPL, therefore we cannot provide mongodb while upholding to good security standards. It turns out feff80cec3c97a3df2c20d300be12d67f79d4f22 was right since while the main license file wasnt altered to SSPL, some files in the tree contain SSPL headers. * gnu/packages/databases.scm (go-gopkg.in-mgo.v2): Remove. * gnu/packages/databases.scm (mongo-tools): Remove. * doc/guix.texi (mongodb-service-type): Remove. * gnu/tests/databases.scm (%test-mongodb, %mongodb-os, run-mongodb-test): Remove. * gnu/services/databases.scm (mongodb-configuration, mongodb-configuration?, mongodb-configuration-mongodb, mongodb-configuration-config-file, mongodb-configuration-data-directory, mongodb-service-type, %default-mongodb-configuration-file, %mongodb-accounts, mongodb-activation, mongodb-shepherd-service): Remove. * gnu/packages/databases.scm (mongodb): Remove. Léo Le Bouter
2021-03-15services/qemu-binfmt: Use the F flag and the static output of QEMU....Fixes <https://issues.guix.gnu.org/36117>. Before this change, the 'binfmt_misc' entries registered for QEMU would not be usable in container contexts outside of guix-daemon (without manually bind mounting file names). For example: $ docker run --rm arm32v7/debian true standard_init_linux.go:207: exec user process caused "no such file or directory" After this change, any container can make use of the QEMU binfmt_misc registrations, as their corresponding QEMU static binaries are fully pre-loaded by the kernel. * gnu/services/virtualization.scm (<qemu-platform>): Define using 'define-record-type*'. [flags]: New field, which defaults to "F" (fix binary). (%i386, %i486, %alpha, %arm, %armeb, %sparc, %sparc32plus, %ppc, %ppc64) (%ppc64le, %m68k, %mips, %mipsel, %mipsn32, %mipsn32el, %mips64, %mips64el) (%riscv32, %riscv64, %sh4, %sh4eb, %s390x, %aarch64, %hppa): Adjust. (qemu-binfmt-guix-chroot): Remove variable. (qemu-binfmt-service-type): Remove the qemu-binfmt-guix-chroot extension. * gnu/services/qemu-binfmt (qemu-platform->binfmt): Use the static output of QEMU. * doc/contributing.texi (Submitting Patches): Update doc. * doc/guix.texi (Virtualization Services): Update doc. Maxim Cournoyer
2021-03-14build-system/cargo: Propagate crates across builds....* guix/build-system/cargo.scm (cargo-build): Add cargo-package-flags, install-source flags. * guix/build/cargo-build-system.scm (unpack-rust-crates, package): New procedures. (install): Also install crate sources. (%standard-phases): Add new phases. * doc/guix.texi (Packaging-guidelines)[Rust Crates]: Adjust to changes in the cargo-build-system. Efraim Flashner
2021-03-12utils: Use Guile-zlib for gzip compression and decompression....Fixes <https://bugs.gnu.org/46967>. * guix/utils.scm (decompressed-port): Call 'make-zlib-input-port' instead of invoking %GZIP. (compressed-output-port): Call 'make-zlib-output-port' instead of invoking %GZIP. * doc/guix.texi (Requirements): Require Guile-zlib >= 0.1.0. Ludovic Courtès
2021-03-10import: Add Go importer....This patch adds a 'guix import go' command. * doc/guix.texi (Requirements): Mention Guile-Lib dependency. (Invoking guix import): Document 'guix import go'. * gnu/packages/package-management.scm (guix)[inputs, propagated-inputs]: Add GUILE-LIB. * guix/self.scm (compiled-guix)[guile-lib]: New variable. [dependencies]: Add it. (specification->package): Add "guile-lib". * guix/build-system/go.scm (go-version->git-ref): New procedure. * guix/import/go.scm, guix/scripts/import/go.scm, tests/go.scm: New files. * guix/scripts/import.scm: Declare subcommand guix import go * po/guix/POTFILES.in: Add 'guix/scripts/import/go.scm'. * Makefile.am (MODULES): Add 'guix/import/go.scm' and 'guix/scripts/import/go.scm'. (SCM_TESTS): Add 'tests/go.scm'. Co-Authored-By: Helio Machado <0x2b3bfa0@gmail.com> Co-Authored-By: Francois Joulaud <francois.joulaud@radiofrance.com> Co-Authored-By: Maxim Cournoyer <maxim.cournoyer@gmail.com> Co-Authored-by: Ludovic Courtès <ludo@gnu.org> Katherine Cox-Buday
2021-03-10doc: Fix grammar....* doc/contributing.texi (Package Naming): Fix grammar. Tobias Geerinckx-Rice
2021-03-06doc: Fix a grammatical error in the system installation guide....* doc/guix.texi (After System Installation): Fix grammar. Signed-off-by: Leo Famulari <leo@famulari.name> Edgar Vincent
2021-03-05doc: Refer to the right node for '--keep-failed'....* doc/guix.texi (Invoking guix-daemon, Debugging Build Failures): Refer to "Common Build Options" for '--keep-failed'. Ludovic Courtès
2021-03-05services: guix-build-coordinator: Add dynamic auth with file record....* gnu/services/guix.scm (guix-build-coordinator-agent-dynamic-auth-with-file, guix-build-coordinator-agent-dynamic-auth-with-filen?, guix-build-coordinator-agent-dynamic-auth-with-file-agent-name, guix-build-coordinator-agent-dynamic-auth-with-file-token-file): New procedures. (guix-build-coordinator-agent-shepherd-services): Handle new dynamic auth with file record. * doc/guix.texi (Guix Build Coordinator): Document the new dynamic auth with file record. Christopher Baines
2021-02-28services: guix-build-coordinator: Add dynamic auth record....* gnu/services/guix.scm (guix-build-coordinator-agent-dynamic-auth, guix-build-coordinator-agent-dynamic-auth?, guix-build-coordinator-agent-dynamic-auth-agent-name, guix-build-coordinator-agent-dynamic-auth-token): New procedures. (guix-build-coordinator-agent-shepherd-services): Handle new dynamic auth record. * doc/guix.texi (Guix Build Coordinator): Document the new dynamic auth record. Christopher Baines
2021-02-28services: guix-build-coordinator: Rework authentication config....A new authentication approach has been added to the coordinator, so to better represent the options, this commit changes the configuration to accept different records, each for different authentication approaches. * gnu/services/guix.scm (guix-build-coordinator-agent-configuration-uuid, guix-build-coordinator-agent-configuration-password, guix-build-coordinator-agent-configuration-password-file): Removed procedures. (guix-build-coordinator-agent-password-auth, guix-build-coordinator-agent-password-auth?, guix-build-coordinator-agent-password-auth-uuid, guix-build-coordinator-agent-password-auth-password, guix-build-coordinator-agent-password-file-auth, guix-build-coordinator-agent-password-file-auth?, guix-build-coordinator-agent-password-file-auth-uuid, guix-build-coordinator-agent-password-file-auth-password-file): New procedures. (guix-build-coordinator-agent-shepherd-services): Adjust to handle the authentication field and it's possible record values. * doc/guix.texi (Guix Build Coordinator): Update documentation. Christopher Baines
2021-02-25doc: Fix typo....* doc/guix.texi (Reduced Binary Seed Bootstrap): Fix typo. Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr> Gurjeet Singh
2021-02-23doc: Expand sane-service-type documentation....* doc/guix.texi (sane-service-type): Move from between documentation about geoclue, expand slightly. (sane-backends-minimal): New description. (sane-backends): New description, new example. Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr> raid5atemyhomework
2021-02-23services: cuirass: Improve simple-cuirass-services....Instead of returning multiple services in simple-cuirass-services, rely on the instantiate-missing-services procedure to instantiate postgresql and postgresql-role-service-type when missing. Turn simple-cuirass-services procedure into simple-cuirass-configuration->specs, that takes a simple-cuirass-configuration record and returns a Cuirass specification. Suggested-by: Ludovic Courtès <ludo@gnu.org> * gnu/services/cuirass.scm (%default-cuirass-config): Remove it. (simple-cuirass-services): Rename it to ... (simple-cuirass-configuration->specs): ... this procedure. * gnu/tests/cuirass.scm (cuirass-services): Remove postgresql and postgresql-role services that are automatically instantiated. (simple-cuirass-service): New variable. (%cuirass-simple-test): Adapt it to use simple-cuirass-configuration->specs instead of simple-cuirass-services. * doc/guix.texi (Simple Cuirass): Update it. Mathieu Othacehe
2021-02-22doc: Fix build....This is a follow-up of b309a28678664c295e97a70607def02b0c9b4296. * doc/guix.texi (Tor): Fix build. Mathieu Othacehe
2021-02-22services: tor: Add control-socket? option....* doc/guix.texi (Networking Services): Document new `control-socket?' option for `tor-configuration`. * gnu/services/networking.scm (<tor-configuration>): (tor-configuration->torrc): Christopher Lemmer Webber
2021-02-20doc: Fix typography....* doc/guix.texi (Continuous Integration): Use @pxref appropriately. Remove `quote' from code examples. Nicolas Goaziou
2021-02-19services: cuirass: Add "simple-cuirass-services"....* gnu/services/cuirass.scm (<build-manifest>, <simple-cuirass-configuration>): New records. (build-manifest, build-manifest?, simple-cuirass-configuration, simple-cuirass-configuration?, simple-cuirass-services): New procedures. (%default-cuirass-config): New variable. * gnu/tests/cuirass.scm (%cuirass-simple-test): New variable. * doc/guix.texi (Continuous Integration): Document it. Mathieu Othacehe
2021-02-19doc: Add an example of how the open file descriptors limit can be raised....* doc/guix.texi (Base Services)[pam-limits-service]: Add an example and explanation of how the 'nofile', or open file descriptors value, can be configured. Maxim Cournoyer
2021-02-17scripts: system: Remove 'vm-image' command....Remove the 'vm-image' command that has been superseded by the 'image' command. * gnu/system/vm.scm (system-qemu-image): Remove it. * guix/scripts/system.scm (system-derivation-for-action): Mark 'vm-image' command as deprecated and use the image API to produce the VM image. (perform-action, show-help): Adapt accordingly. * tests/guix-system.sh: Ditto. * doc/guix.texi (Invoking guix system, Running Guix in a VM): Ditto. * etc/completion/fish/guix.fish: Ditto. * etc/completion/zsh/_guix: Ditto. Mathieu Othacehe
2021-02-17services: wireguard: New service....* gnu/services/vpn.scm (wireguard-peer, wireguard-configuration): New records. (wireguard-service-type): New variable. * doc/guix.texi (VPN Services): Document it. Mathieu Othacehe
2021-02-15services: Add Agate Gemini service....* gnu/services/web.scm (<agate-configuration>): New record type. (agate-accounts, agate-shepherd-service): New procedures. (agate-service-type): New variable. * doc/guix.texi (Web Services): Document it. Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr> Alexandru-Sergiu Marton
2021-02-15doc: Explain how to exit and clean up a Guix environment....* doc/guix.texi (Invoking guix environment): Explain how to exit and clean up a Guix environment. The current documentation doesn't explain how to exit an environment or how to remove the packages after exiting. Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr> Lee