summary refs log tree commit diff
path: root/doc/guix.texi
AgeCommit message (Collapse)Author
2020-08-10doc: Fix a typo.Tobias Geerinckx-Rice
* doc/guix.texi (operating-system Reference): Fix a typo & sigh. Reported by Jakub Kądziołka <kuba@kadziolka.net>.
2020-08-09doc: Shrink width of deeply-indented code sample.Tobias Geerinckx-Rice
This follows up on commit 4cafdce2102e3ebc7b3a6152464a62a454b6be45. * doc/guix.texi (operating-system Reference): Shorten comments to fit everything on an 80-character punch card.
2020-08-09doc: Explain how to select system package outputs.Tobias Geerinckx-Rice
* doc/guix.texi (operating-system Reference): Document that PACKAGES may contain traces of tuples and give an example.
2020-08-09doc: Fix typo.Tobias Geerinckx-Rice
* doc/guix.texi (operating-system Reference): Add missing ‘of’.
2020-08-03doc: Document 'mount-may-fail?' field.Ludovic Courtès
This is a followup to 7c27bd115b14afd142da7684cc349369965f9eab. * doc/guix.texi (File Systems): Document 'mount-may-fail?'.
2020-08-02services: Add zram-device-service.Efraim Flashner
* gnu/services/linux.scm (<zram-device-configuration>): New record. (zram-device-service-type): New variable. * doc/guix.texi (Linux Services): Document it. * tests/services/linux.scm (zram-swap-device-test): New tests.
2020-08-01doc: Explain how to use psql with peer authentication.Pierre Neidhardt
* doc/guix.texi (Database Services): Add example of shell commands to use psql as system user. Also add troubleshooting tip when service fails to start because of incompatible cluster.
2020-07-29doc: Extend tlp-service-type example.Tobias Geerinckx-Rice
* doc/guix.texi (Power Management Services): Demonstrate tlp-configuration usage. Suggested by rovanion on #guix.
2020-07-28doc: Warn against using the .scm extension for the channel news file.Pierre Neidhardt
* doc/guix.texi (Writing Channel News): Explain the issue with using the .scm extension and possible workarounds; fix the example to use the .txt extension instead.
2020-07-27services: auditd: Provide default configuration directory.Robin Green
* gnu/services/auditd.scm (auditd.conf) (%default-auditd-configuration-directory): New variables. (<auditd-configuration>): Switch to 'define-record-type*'. [configuration-directory]: New field. (auditd-shepherd-service): Honor 'configuration-directory'. Pass #:pid-file. (auditd-service-type)[description]: Tweak. [default-value]: Provide 'configuration-directory'. * doc/guix.texi (Miscellaneous Services): Update docs to reflect changes. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-07-27services: Add 'unattended-upgrade-service-type'.Ludovic Courtès
* gnu/services/admin.scm (<unattended-upgrade-configuration>): New record type. (%unattended-upgrade-log-file): New variable. (unattended-upgrade-mcron-jobs, unattended-upgrade-log-rotations): New procedures. (unattended-upgrade-service-type): New variable. * doc/guix.texi (Service Reference): Add 'provenance-service-type' anchor. (Unattended Upgrades): New section.
2020-07-27machine: ssh: Check for potential system downgrades.Ludovic Courtès
This is a followup to 8e31736b0a60919cc1bfc5dc22c395b09243484a. * guix/scripts/system/reconfigure.scm (check-forward-update): Add #:current-channels. Use it instead of OLD. * gnu/services.scm (sexp->system-provenance): New procedure. (system-provenance): Use it. * gnu/machine/ssh.scm (<machine-ssh-configuration>)[allow-downgrades?]: New field. (machine-check-forward-update): New procedure. (check-deployment-sanity)[assertions]: Call it. * doc/guix.texi (Invoking guix deploy): Document 'allow-downgrades?' field.
2020-07-25services: nix: Add extra-options.Oleg Pykhalov
* gnu/services/nix.scm (<nix-configuration>)[extra-options]: New field. (nix-shepherd-service): Add this. (nix-activation): Add new line to the end of /etc/nix/nix.conf file. * doc/guix.texi (Miscellaneous Services)[Nix service]: Document this.
2020-07-24doc: Mention the channel keyring branch.Ludovic Courtès
Reported by Pierre Neidhardt <mail@ambrevar.xyz>. * doc/guix.texi (Channels): Mention the keyring branch and the 'keyring-reference' bit in '.guix-channel'.
2020-07-24doc: Use an existing commit in channel example.Ludovic Courtès
Suggested by zimoun <zimon.toutoune@gmail.com>. * doc/guix.texi (Channels): Use the commit for 'v1.0.0' instead of a non-existing commit in example.
2020-07-23guix system: 'reconfigure' disallows downgrades by default.Ludovic Courtès
This is similar to what 9744cc7b4636fafb772c94adb8f05961b5b39f16 did for 'guix pull'. * guix/scripts/system/reconfigure.scm (ensure-forward-reconfigure) (warn-about-backward-reconfigure, channel-relations) (check-forward-update): New procedures. * guix/scripts/system.scm (perform-action): Add #:validate-reconfigure. Call 'check-forward-update' when ACTION is 'reconfigure. (%options, show-help): Add "--allow-downgrades". (%default-options): Add 'validate-reconfigure' key. (process-action): Pass #:validate-reconfigure to 'perform-action'. * doc/guix.texi (Invoking guix system): Document 'guix system describe' more prominently, and document '--allow-downgrades'.
2020-07-23doc: Tweak mcron example.Ludovic Courtès
* doc/guix.texi (Scheduled Job Execution): In example, move '%min-level' definition after 'use-modules'.
2020-07-22services: nix: Fix sandbox.Oleg Pykhalov
* gnu/tests/package-management.scm: New file. * gnu/local.mk: Add this. * gnu/services/nix.scm (<nix-configuration>): New record. (nix-activation): Generate Nix config file which fixes sandbox. (nix-service-type): Add default value. (nix-shepherd-service): Allow provide Nix package. * doc/guix.texi (Miscellaneous Services)[Nix service]<nix-configuration>: Document record.
2020-07-21doc: Mention the 'savannah' updater.Ludovic Courtès
* doc/guix.texi (Invoking guix refresh): Mention 'savannah' updater.
2020-07-20ssh: Speed up RPCs by using #:nodelay.Lars-Dominik Braun
Partly fixes <https://bugs.gnu.org/41702>. * guix/ssh.scm (open-ssh-session): Enable #:nodelay. * m4/guix.m4 (GUIX_CHECK_GUILE_SSH): Add feature check for this new parameter. * doc/guix.texi (Requirements): Adjust. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2020-07-19doc: Fix Ganeti blog post URL.Marius Bakke
* doc/guix.texi (Virtualization Services): Adjust Ganeti blog post URL.
2020-07-19services: ganeti: Use TLS on the remote API by default.Marius Bakke
* gnu/services/ganeti.scm (<ganeti-rapi-configuration>): Set SSL? to #t. * gnu/tests/ganeti.scm (%ganeti-os): Set SSL? to #f. * doc/guix.texi (Virtualization Services): Adjust accordingly.
2020-07-17build-system/maven: Make default-maven-plugins a procedure.Christopher Baines
This allows compiling the module without the (gnu packages maven) module being available. * guix/build-system/maven.scm (%default-maven-plugins): Rename to default-maven-plugins, and convert to a procedure. * doc/guix.texi (maven-build-system): Update.
2020-07-17guix: Add maven-build-system.Julien Lepiller
* guix/build-system/maven.scm: New file. * guix/build/maven-build-system.scm: New file. * Makefile.am (MODULES): Add them. * doc/guix.texi (Build Systems): Document the maven build system.
2020-07-17doc: Small fixups for the Ganeti documentation.Marius Bakke
* doc/guix.texi (Virtualization Services): Fix various inaccuracies and add markup the procedure parameters.
2020-07-16services: Add ganeti.Marius Bakke
* gnu/services/ganeti.scm, gnu/tests/ganeti.scm: New files. * doc/guix.texi (Virtualization Services): Document the Ganeti services.
2020-07-11Add 'guix git authenticate'.Ludovic Courtès
* guix/scripts/git.scm, guix/scripts/git/authenticate.scm, tests/guix-git-authenticate.sh: New files. * Makefile.am (MODULES): Add the *.scm files. (SH_TESTS): Add 'tests/guix-git-authenticate.sh'. * doc/guix.texi (Channels)[Specifying Channel Authorizations]: Mention 'guix git authenticate'. (Invoking guix git authenticate): New node. * po/guix/POTFILES.in: Add 'guix/scripts/git.scm' and 'guix/scripts/git/authenticate.scm'.
2020-07-06doc: Fix texinfo identifiers in Version Control Services.Arun Isaac
* doc/guix.texi (Version Control Services): Use @code, @command, @file, @indicateurl, @samp texinfo identifiers correctly.
2020-07-05doc: Fix minor typo in X Window.Arun Isaac
* doc/guix.texi (X Window): Replace "not" with "no".
2020-07-05doc: Fix minor typo in Programming Interface.Arun Isaac
* doc/guix.texi (Programming Interface): Replace "under a specific build users" with "under specific build users".
2020-07-02services: wpa-supplicant: Support specifying additional service dependencies.Marius Bakke
* gnu/services/networking.scm (<wpa-supplicant-configuration>)[requirement]: New parameter. (wpa-supplicant-shepherd-service): Use it instead of hard-coded list. * doc/guix.texi (Networking Services): Document accordingly.
2020-07-01channels: Dependencies listed in '.guix-channel' can have an introduction.Ludovic Courtès
Suggested by Ricardo Wurmus and Simon Tournier. * guix/channels.scm (sexp->channel-introduction): New procedure. (read-channel-metadata): Use it. (profile-channels)[sexp->channel-introduction]: Remove. * tests/channels.scm ("latest-channel-instances, authenticate dependency"): New test. * doc/guix.texi (Channels)[Declaring Channel Dependencies]: Augment example.
2020-07-01guix describe: Display channel introductions and add 'channels-sans-intro'.Ludovic Courtès
* guix/scripts/describe.scm (%available-formats): Add "channels-sans-intro". (channel->sexp): Add #:include-introduction?. Emit CHANNEL's intro if INCLUDE-INTRODUCTION? is true and CHANNEL has an introduction. (channel->json): Include CHANNEL's introduction, if any. (channel->recutils): Likewise. (display-profile-info): Add 'channels-sans-intro' case. * doc/guix.texi (Invoking guix describe): Add introduction in example. Add 'channels-sans-intro' case.
2020-07-01channels: Make channel introductions public.Ludovic Courtès
* guix/channels.scm (<channel-introduction>): Rename constructor to '%make-channel-introduction'. (make-channel-introduction): New procedure. * tests/channels.scm ("authenticate-channel, wrong first commit signer") ("authenticate-channel, .guix-authorizations"): Use 'make-channel-introduction' without '@@' and without third argument. * doc/guix.texi (Channels)[Channel Authentication, Specifying Channel Authorizations]: New subsections.
2020-06-28doc: Add progress display in 'dd' command lines.Brice Waegeneire
* doc/guix.texi (System Installation): Adjust 'dd' command line to display progress … (System Configuration): … same here.
2020-06-28services: Add rshiny service.Efraim Flashner
* gnu/services/science.scm: New file. (<rshiny-configuration>): New record. (rshiny-shepherd-service-type): New variable. * doc/guix.texi (Miscellaneous Services): Document it. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it.
2020-06-26doc: 'guix hash' is not SHA256-only.Ludovic Courtès
This is a followup to 18ae1ec3ecfe22d55d6cdf595a442afebbc5595a. * doc/guix.texi (Invoking guix hash): Remove "SHA256" from the first paragraph.
2020-06-21services: childhurd: Support more than one instance.Jan (janneke) Nieuwenhuizen
* gnu/services/virtualization.scm (<hurd-vm-configuration>)[options]: Remove "--hda" option. [id,net-options]: New fields. (hurd-vm-net-options): New procedure. Parameterize port forwarding with ID. * gnu/services/virtualization.scm (hurd-vm-shepherd-service): Use them. Parameterize provision with ID, if set. Hardcode "--hda" option for image. * doc/guix.texi (Virtualization Services): Document new fields. Update for hardcoding of "--hda".
2020-06-18doc: Delete description of a nonexistent option.Timotej Lazar
* doc/guix.texi (Invoking guix pull): Delete a paragraph about the --verbose option, which was removed in 1edcfda81ba5c20ca715473d45315662c60dd81e. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-06-17channels: Warn when pulling from a mirror.Ludovic Courtès
* guix/channels.scm (<channel-metadata>)[url]: New field. (read-channel-metadata): Initialize it. (read-channel-metadata-from-source): Likewise. (channel-instance-primary-url): New procedure. (latest-channel-instances): Compare CHANNEL's URL against it. * doc/guix.texi (Channels)[Primary URL]: New subsection.
2020-06-16pull: Add '--disable-authentication'.Ludovic Courtès
* guix/channels.scm (latest-channel-instance): Add #:authenticate? and honor it. (latest-channel-instances): Likewise. * guix/scripts/pull.scm (%default-options): Add 'authenticate-channels?'. (show-help, %options): Add '--disable-authentication'. (guix-pull): Pass #:authenticate? to 'latest-channel-instances'. * doc/guix.texi (Invoking guix pull): Document it.
2020-06-16channels: 'latest-channel-instance' authenticates Git checkouts.Ludovic Courtès
Fixes <https://bugs.gnu.org/22883>. * guix/channels.scm (<channel>)[introduction]: New field. (<channel-introduction>): New record type. (%guix-channel-introduction): New variable. (%default-channels): Use it. (<channel-metadata>)[keyring-reference]: New field. (%default-keyring-reference): New variable. (read-channel-metadata, read-channel-metadata-from-source): Initialize the 'keyring-reference' field. (commit-short-id, verify-introductory-commit) (authenticate-channel): New procedures. (latest-channel-instance): Call 'authenticate-channel' when CHANNEL has an introduction. * tests/channels.scm (gpg+git-available?, commit-id-string): New procedures. ("authenticate-channel, wrong first commit signer"): ("authenticate-channel, .guix-authorizations"): New tests. * doc/guix.texi (Invoking guix pull): Mention authentication.
2020-06-16pack: Add zstd compressor.Tobias Geerinckx-Rice
* guix/scripts/pack.scm (%compressors): Add zstd. * doc/guix.texi (Invoking guix pack): Document it.
2020-06-15doc: Clarify 'hurd-vm' and 'childhurd' names.Jan (janneke) Nieuwenhuizen
Suggested by Maxim Cournoyer via IRC. * doc/guix.texi (The Hurd in a Virtual Machine): Explicitly mention that hurd-vm and childhurd are two names for this service.
2020-06-14guix repl: Add script execution.Konrad Hinsen
* guix/scripts/repl.scm: Add filename options for script execution. * doc/guix.texi (Invoking guix repl): Document it. * tests/guix-repl.sh: Test it. * Makefile.am: (SH_TESTS): Add it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-06-14services: Add 'hurd-vm service-type'.Jan (janneke) Nieuwenhuizen
* gnu/services/virtualization.scm (hurd-vm-shepherd-service, hurd-vm-disk-image): New procedures. (%hurd-vm-operating-system, hurd-vm-service-type): New variables. (<hurd-vm-configuration>): New record type. * doc/guix.texi (Virtualization Services): Document it. * gnu/services/shepherd.scm (scm->go): Use let-system, remove FIXME. Fixes fixes cross-building of shepherd modules for the Hurd image.
2020-06-14lint: Add 'check-for-collisions' checker.Ludovic Courtès
Suggested by Edouard Klein <edk@beaver-labs.com>. * guix/profiles.scm (check-for-collisions): Export. * guix/lint.scm (check-profile-collisions): New procedure. (%local-checkers): Add 'profile-collisions' checker. * tests/lint.scm ("profile-collisions: no warnings") ("profile-collisions: propagated inputs collide") ("profile-collisions: propagated inputs collide, store items"): New tests. * doc/guix.texi (Invoking guix lint): Document it.
2020-06-14doc: Mention 'guix lint -c derivation'.Ludovic Courtès
* doc/guix.texi (Invoking guix lint): Mention the 'derivation' checker.
2020-06-09doc: Add note to 'udisks-service'.Brice Waegeneire
* doc/guix.texi (Desktop Services): Specify how to add file-systems utilities to 'udisks-service'.
2020-06-08services: Add `hurd-getty-service-type'.Jan (janneke) Nieuwenhuizen
* gnu/services/hurd.scm (<hurd-gettty-configuration>): New record. (hurd-ttys-shepherd-service): New procedure. (hurd-getty-service-type): New variable. * doc/guix.texi (Hurd Services): Document it.