summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)Author
2021-02-25doc: Fix typo.Gurjeet Singh
* doc/guix.texi (Reduced Binary Seed Bootstrap): Fix typo. Signed-off-by: Nicolas Goaziou <mail@nicolasgoaziou.fr>
2021-02-23doc: Expand sane-service-type documentation.raid5atemyhomework
* 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>
2021-02-23services: cuirass: Improve simple-cuirass-services.Mathieu Othacehe
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.
2021-02-22doc: Fix build.Mathieu Othacehe
This is a follow-up of b309a28678664c295e97a70607def02b0c9b4296. * doc/guix.texi (Tor): Fix build.
2021-02-22services: tor: Add control-socket? option.Christopher Lemmer Webber
* doc/guix.texi (Networking Services): Document new `control-socket?' option for `tor-configuration`. * gnu/services/networking.scm (<tor-configuration>): (tor-configuration->torrc):
2021-02-20doc: Fix typography.Nicolas Goaziou
* doc/guix.texi (Continuous Integration): Use @pxref appropriately. Remove `quote' from code examples.
2021-02-19services: cuirass: Add "simple-cuirass-services".Mathieu Othacehe
* 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.
2021-02-19doc: Add an example of how the open file descriptors limit can be raised.Maxim Cournoyer
* 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.
2021-02-17scripts: system: Remove 'vm-image' command.Mathieu Othacehe
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.
2021-02-17services: wireguard: New service.Mathieu Othacehe
* gnu/services/vpn.scm (wireguard-peer, wireguard-configuration): New records. (wireguard-service-type): New variable. * doc/guix.texi (VPN Services): Document it.
2021-02-15services: Add Agate Gemini service.Alexandru-Sergiu Marton
* 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>
2021-02-15doc: Explain how to exit and clean up a Guix environment.Lee
* 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>
2021-02-13doc: Try again to the improve the branching workflow.Leo Famulari
This is a followup to commit 175bea0ca42dba3e02109820efae0cac2804e73b. * doc/contributing.texi (Submitting Patches): Distill the workflow to its essence.
2021-02-12doc: Fix for 'guix pull'.宋文武
Fixes a regression introduced in db6b9d2f4bc59511904e8c1412d0257675c46095. * doc/guix.texi (File-Sharing Services): Remove space after '@pxref'.
2021-02-12services: Add transmission-daemon service.Simon South
* gnu/services/file-sharing.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * po/packages/POTFILES.in: Add it. * tests/services/file-sharing.scm: New file. * Makefile.am (SCM_TESTS): Add it. * doc/guix.texi (File-Sharing Services): New section. Signed-off-by: 宋文武 <iyzsong@member.fsf.org>
2021-02-11doc: Try to improve the branching workflow.Leo Famulari
* doc/contributing.texi (Submitting Patches): Introduce the use of "-frozen" branch names.
2021-02-07build-system: Add renpy-build-system.Leo Prikler
* guix/build/renpy-build-system.scm: New file. * guix/build-system/renpy.scm: New file. * Makefile.am (MODULES): Add them here. * doc/guix.texi (Build Systems): Document renpy-build-system.
2021-02-02services: postgresql: Update documented socket directory to match code.Ben Sturmfels
This is a follow-up of 6c0679215f4ffa534c1eb2e8c8a6e043a0c993fe. * doc/guix.texi (Database Services): Update it. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-02-02build: Add a --show-duration option to the SCM test-driver.Maxim Cournoyer
* build-aux/test-driver.scm (script-version): Update. (show-help): Document it. (%options): Add the 'show-duration' option. (test-runner-gnu): Pass as a new argument. [test-cases-start-time]: New inner variable. [test-on-test-begin-gnu]: New hook, used to record the start time. [test-on-test-end-gnu]: Conditionally print elapsed time. Record it as the optional metadata in the test result file (.trs). * doc/guix.texi (Running the Test Suite): Document it.
2021-02-01doc: Explain how to set custom Shepherd package.Oleg Pykhalov
* doc/guix.texi (Shepherd Services): Give example on how to set custom Shepherd package.
2021-02-01guix package: Add '--export-channels'.Ludovic Courtès
* guix/channels.scm (sexp->channel): Export. * guix/describe.scm: Use (guix channels). (manifest-entry-provenance): New procedure. * guix/scripts/package.scm (channel=?, export-channels): New procedures. (show-help, %options): Add '--export-channels'. (process-query): Honor it. * build-aux/build-self.scm (build-program)[select?]: Exclude (guix channels) to account for the (guix describe) change above. * doc/guix.texi (Invoking guix package): Document it.
2021-02-01guix package: Add '--export-manifest'.Ludovic Courtès
* guix/scripts/package.scm (export-manifest): New procedure. (show-help, %options): Add '--export-manifest'. (process-query): Honor it. * guix/build/profiles.scm (build-profile): Mention it. * tests/guix-package.sh: Test it. * doc/guix.texi (Invoking guix package): Document it.
2021-01-31build: test-driver.scm: Add a new '--errors-only' option.Maxim Cournoyer
* build-aux/test-driver.scm (show-help): Add the help text for the new '--errors-only' option. (%options): Add the errors-only option. (test-runner-gnu): Add the errors-only? parameter and update doc. Move the logging of the test data after the test has completed, so a choice can be made whether to keep it or discard it based on the value of the test result. (main): Pass the errors-only? option to the driver. * doc/guix.texi (Running the Test Suite): Document the new option.
2021-01-31build: test-driver.scm: Add test cases filtering options.Maxim Cournoyer
* build-aux/test-driver.scm (show-help): Add help text for the new --select and --exclude options. (%options): Add the new select and exclude options. (test-runner-gnu): Pass them to the test runner. Update doc. (test-match-name*, test-match-name*/negated, %test-match-all): New variables. (main): Compute the test specifier based on the values of the new options and apply it to the current test runner when running the test file. * doc/guix.texi (Running the Test Suite): Document the new options.
2021-01-31guix: channels: Introduce "channel-with-substitutes-available".Mathieu Othacehe
* guix/channels.scm (find-latest-commit-with-substitutes, channel-with-substitutes-available): New procedures. * guix/scripts/pull.scm (guix-pull): Move "channel-list" call inside the %current-system parameter scope. * doc/guix.texi (Channels with substitutes): New section.
2021-01-30services: shepherd: Allow custom 'shepherd' package.Maxime Devos
* gnu/services/shepherd.scm (<shepherd-configuration>): New record. (shepherd-boot-gexp, shepherd-root-service-type): Use it. (scm->go, shepherd-configuration-file): Allow passing custom shepherd package. * gnu/system.scm (operating-system-shepherd-service-names): Use the new record. * guix/scripts/system.scm (export-shepherd-graph): Adjust accordingly. * doc/guix.texi (Shepherd Services). Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2021-01-30build-system/julia: Don't rely on file name to set module name.nixo
* guix/build/julia-build-system.scm (project.toml->name): New procedure. (precompile, check, julia-build): Accept new key argument #:julia-package-name. * guix/build-system/julia.scm (julia-build): ... add it. * doc/guix.texi (julia-build-system): Update julia-package-name accordingly. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-01-30build-system/julia: Enable tests.nixo
* guix/build-system/julia.scm (julia-build): Set tests? default to #t. * guix/build/julia-build-system.scm (check): Respect tests? and fix julia invocation. (%standard-phases): Add check phase after install. * doc/guix.texi (julia-build-system): Update accordingly. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-01-29doc: Update guidance about Rust package naming.Hartmut Goebel
* doc/contributing.texi (Rust Crates): Explain versions suffix based on packages version and Crate "caret" versioning.
2021-01-28doc: Fix mapped devices example in the manual.Joshua Branson
Reported by Raghav Gururajan <rg@raghavgururajan.name> and Mikhail Tsykalov <tsymsh@gmail.com>. * doc/guix.texi (Mapped Devices): Replace target with targets. Signed-off-by: Leo Famulari <leo@famulari.name>
2021-01-28services: postgresql: Add postgresql-role-service-type.Mathieu Othacehe
* gnu/services/databases.scm (postgresql-role, postgresql-role?, postgresql-role-name, postgresql-role-permissions, postgresql-role-create-database?, postgresql-role-configuration, postgresql-role-configuration?, postgresql-role-configuration-host, postgresql-role-configuration-roles, postgresql-role-service-type): New procedures. * gnu/tests/databases.scm: Test it. * doc/guix.texi: Document it.
2021-01-28services: postgresql: Add log directory support.Mathieu Othacehe
* gnu/services/databases.scm (postgresql-configuration-log-directory): New procedure. (<postgresql-configuration>)[log-directory]: New field. (postgresql-activation): Create the log directory. (postgresql-shepherd-service): Honor it. * gnu/tests/databases.scm (%postgresql-log-directory): New variable. (log-file): New test case. * doc/guix.texi (Database Services): Document it.
2021-01-28services: postgresql: Add socket directory support.Mathieu Othacehe
* gnu/services/databases.scm (postgresql-config-file-socket-directory): New procedure. (<postgresql-config-file>)[socket-directory]: New field. (postgresql-config-file-compiler): Honor it. (postgresql-activation): Create the socket directory if needed. * doc/guix.texi (Database Services): Document it. * gnu/tests/guix.scm (%guix-data-service-os): Adapt it. * gnu/tests/monitoring.scm (%zabbix-os): Ditto. * gnu/tests/web.scm (patchwork-os): Ditto. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-01-28services: postgresql: Use Guile datatypes.Mathieu Othacehe
* gnu/services/databases.scm (postgresql-config-file-compiler): Support Guile datatypes in the "extra-config" field. * gnu/tests/databases.scm (%postgresql-os): Test it. * doc/guix.texi (Database Services): Document it.
2021-01-24doc: Clarify that package transformations are preserved across upgrades.Ludovic Courtès
Reported by pineapples on #guix. This is a followup to 8e1907a72430aa989125b053573ef0897c480697. * doc/guix.texi (Invoking guix package): Remove sentence that says that package transformations are lost upon upgrading and explicitly say the opposite.
2021-01-21doc: Properly close sentences ending with an upper-case letter.Nicolas Goaziou
* doc/guix.texi (Application Setup): (USB Stick and DVD Installation): (Proxy Settings): (Primary URL): (origin Reference): (Build Systems): (The Store): (Package Transformation Options): (Invoking guix lint): (Invoking guix graph): (operating-system Reference): (X Window): (Desktop Services): (Database Services): (Mail Services): (Messaging Services): (Monitoring Services): (LDAP Services): (Certificate Services): (DNS Services): (VPN Services): (Power Management Services): (Virtualization Services): (Version Control Services): (Name Service Switch): (Bootloader Configuration): (Running Guix in a VM): (Separate Debug Info): Use "@." to indicate to Texinfo the sentence does end with a capital letter.
2021-01-21doc: cookbook: Add "Guix System Image API" section.Joshua Branson
* doc/guix-cookbook.texi (Guix System Image API): New section. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-01-20doc: Replace TP with Weblate mentions.Julien Lepiller
* doc/contributing.texi: Replace link to TP with a link to Weblate. * doc/guix.texi: Replace link to TP with a link to Weblate. * doc/guix-cookbook.texi: Replace link to TP with a link to Weblate.
2021-01-19transformations: Add '--with-latest'.Ludovic Courtès
* guix/upstream.scm (upstream-source-compiler): New procedure. (%updaters): Set! it. * guix/transformations.scm (transform-package-latest): New procedure. (%transformations): Add 'with-latest'. (%transformation-options, show-transformation-options-help/detailed): Add '--with-latest'. * tests/transformations.scm ("options->transformation, with-latest"): New test. * doc/guix.texi (Package Transformation Options): Document it.
2021-01-19system: Rename 'disk-image' command 'image'.Mathieu Othacehe
* guix/scripts/system.scm (system-derivation-for-action): Rename 'disk-image' command 'image'. Warn when using the now deprecated 'disk-image' command. (show-help): Adapt accordingly. (guix-system): Ditto. * tests/guix-system.sh: Ditto. * gnu/system/examples/bare-hurd.tmpl: Ditto. * doc/guix.texi (Building the Installation Image, Building the Installation Image for ARM Boards, Invoking guix pack, Invoking guix system): Adapt documentation.
2021-01-19doc: Fix typo.Joshua C. Randall
Fixes <http://bugs.gnu.org/35004>. * doc/guix.texi (Invoking guix package): Fix typo. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-01-17image: Rename "raw" image-type to "efi-raw".Mathieu Othacehe
* gnu/system/image.scm (raw-image-type): Rename to "efi-raw-image-type". * guix/scripts/system.scm (%default-options): Adapt accordingly. * doc/guix.texi: Ditto. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org>
2021-01-16services: openntpd: Remove support for deprecated "-s" option.Simon South
* gnu/services/networking.scm (openntpd-configuration): Remove "allow-large-adjustment?" field. (openntpd-shepherd-service): Remove use of "allow-large-adjustment?" configuration field and "-s" daemon option. * tests/networking.scm (%openntpd-conf-sample): Remove "allow-large-adjustment?" field. * doc/guix.texi (Networking Services)[openntpd-service-type]: Remove "allow-large-adjustment?" field from sample configuration. [openntpd-configuration]: Remove description of "allow-large-adjustment?" field. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2021-01-16services: qemu-binfmt: 'guix-support?' defaults to #t.Stefan
* gnu/services/virtualization.scm (qemu-binfmt-service-type)[guix-support?]: Change the default from #f to #t. * doc/guix.texi (Transparent Emulation with QEMU): Change the default of ‘guix-support?’ from #f to #t. Describe the implication of setting it to #f. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2021-01-13doc: Mention optional dependency on Guile-zstd.Ludovic Courtès
* doc/guix.texi (Requirements): Add Guile-zstd.
2021-01-13publish: Add support for zstd compression.Ludovic Courtès
* guix/scripts/publish.scm (compress-nar)[write-compressed-file]: New procedure. Use it for 'gzip' and 'lzip'. Add 'zstd. (nar-response-port, string->compression-type): Add case for 'zstd'. * tests/publish.scm (zstd-supported?): New procedure. ("/nar/zstd/*"): New test. * doc/guix.texi (Invoking guix publish): Document zstd compression. (Base Services): Add cross-reference to the above node.
2021-01-12doc: Remove trace of ci.guix.info.Florian Pelz
* doc/guix.texi (Invoking guix weather): Use default substitute server in example.
2021-01-12services: Add keepalived service.Oleg Pykhalov
* gnu/services/networking.scm (<keepalived-configuration>): New record. (keepalived-shepherd-service): New procedure. (keepalived-service-type): New variable. * doc/guix.texi (Networking Services): Document this.
2021-01-12services: Add syncthing service.Oleg Pykhalov
* gnu/services/syncthing.scm: New file. * gnu/local.mk: Add this. * doc/guix.texi: Document this.
2021-01-12doc: DNS Services: Fix typography.Nicolas Goaziou
* doc/guix.texi (DNS Services): Use appropriate Texinfo markup and capitalization.