aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Expand)Author
2023-05-30home: services: Add msmtp service....* gnu/home/services/mail.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (Mail Home Services): New node. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Tanguy Le Carrour
2023-05-30doc: Update references to the Shepherd manual....* doc/guix.texi (Shepherd Services): Update cross-references to shepherd.info nodes removed in 0.10.0. Ludovic Courtès
2023-05-25doc: Adjust HTML patterns to correctly process Texinfo 6.8 output....Prior to ceb5ef8347ae0e3015296f5c169ab903bac526a8, (@ (gnu packages texinfo) texinfo), which is what is used here, was pointing to version 6.7. * doc/build.scm (html-manual-identifier-index)[build](worthy-entry?): Adjust patterns for Texinfo 6.8. (syntax-highlighted-html)[build](syntax-highlight): Likewise. Ludovic Courtès
2023-05-25doc: Tweak SELinux instructions....* doc/guix.texi (SELinux Support): Add note about 'guix-install.sh'. Provide the absolute file name of 'guix-daemon.cil'. Wrap important commands in @example. Suggest relabeling just /gnu and /var/guix instead of all of /. Add "systemctl restart guix-daemon". Ludovic Courtès
2023-05-24doc: guix.texi: Add Texinfo line breaks....Adds two line breaks to the copyright block. The same kind of breaks [1] are present in the remaining fifty-five entries. [1] https://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html#Line-Breaks * doc (guix.texi): Add Texinfo line breaks. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Felix Lechner
2023-05-24doc: contributing.texi: Specify recipient via equal sign in 'git send-email -......The documentation for git send-email recommends the use of an equal sign when specifying a recipient with the --to option. [1] Adjusts the reference manual accordingly. [1] https://git-scm.com/docs/git-send-email * doc (contributing.texi): Specify recipient via equal sign in 'git send-email --to'. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Felix Lechner
2023-05-24home: services: ssh: Do not empty ~/.ssh/authorized_keys by default....The default was an empty list which would remove any ~/.ssh/authorized_keys file and replace it with a symlink to an empty file. On some systems, notably Ubuntu 22.10, the guix home generated ~/.ssh/authorized_keys file does not allow login. * doc/guix.texi (Secure Shell): Update, describe default #false value. * gnu/home/services/ssh.scm (<home-openssh-configuration>) [authorized-keys]: Change default to #f. (openssh-configuration-files): Cater for default #f value: Do not register "authorized_keys". Janneke Nieuwenhuizen
2023-05-21doc: Clarify instructions for hibernation on a swap file....Fixes <https://issues.guix.gnu.org/62711>. * doc/guix.texi (Swap Space): Change 'resume' argument to a device in example; add comments. Update sentence describing 'resume' and 'resume_offset'. Ludovic Courtès
2023-05-18style: Add 'arguments' styling rule....* guix/scripts/style.scm (unquote->ungexp, gexpify-argument-value) (quote-argument-value, gexpify-argument-tail) (gexpify-package-arguments): New procedures. (%gexp-keywords): New variable. (%options): Add "arguments" case for 'styling-procedure. (show-stylings): Update. * tests/style.scm ("gexpify arguments, already gexpified") ("gexpify arguments, non-gexp arguments, margin comment") ("gexpify arguments, phases and flags") ("gexpify arguments, append arguments") ("gexpify arguments, substitute-keyword-arguments") ("gexpify arguments, append substitute-keyword-arguments"): New tests. * doc/guix.texi (package Reference): For 'arguments', add compatibility note and link to 'guix style'. (Invoking guix style): Document the 'arguments' styling rule. Ludovic Courtès
2023-05-18doc: Change '--with-configure-flag' example to something that works....Passing '-DBUILD_COMPLEX=OFF' to lapack would eventually lead to a link error. Reported by Florian Pelz <pelzflorian@pelzflorian.de>. * doc/guix.texi (Package Transformation Options): Change '--with-configure-flag' example. * etc/news.scm: Likewise. Ludovic Courtès
2023-05-13services: nar-herder: Support extra environment vars....* gnu/services/guix.scm (nar-herder-configuration-extra-environment-variables): New procedure. (nar-herder-shepherd-services): Pass the environment variables to the shepherd. * doc/guix.texi (Guix Services): Document it. Christopher Baines
2023-05-11services: Add vnstat-service-type....* gnu/services/monitoring.scm (vnstat-service-type): New variable. * doc/guix.texi (Monitoring Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-05-11doc: Update dicod-configuration example...* doc/guix.texi (Dictionary Service): Update dicod-configuration example to fix outdated WordNet database configuration. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Nathaniel Nicandro
2023-05-11doc: Clarify substitute* docstring with an example....* doc/guix.texi (Build Utilities): Update the corresponding passage. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Gabriel Wicki
2023-05-11services: dhcp-client-configuration: Add 'shepherd-requirement' field....* gnu/services/networking.scm (<dhcp-client-configuration>) [shepherd-requirement]: New field. (dhcp-client-shepherd-service): Honor it. (dhcp-client-configuration-shepherd-requirement): Export accessor. * doc/guix.texi (Networking Setup): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Sergey Trofimov
2023-05-11gnu: home: services: fontutils: Add support for SXML fragments....* gnu/home/services/fontutils.scm (add-fontconfig-config-file): Add support for adding arbitrary SXML configuration into fonts.conf; * doc/guix.texi (Fonts Services): Update the documentation. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Andrew Patterson
2023-05-10services: guix-build-coordinator-agent: Support max-parallel-uploads....This should be usable with the new guile-gnutls. * gnu/services/guix.scm (guix-build-coordinator-agent-configuration-max-parallel-uploads): New procedure. * gnu/services/guix.scm (guix-build-coordinator-agent-shepherd-services): Use the new argument. * doc/guix.texi (Guix Services): Document it. Christopher Baines
2023-05-10doc: Fix module name for 'home-znc-service-type'....* doc/guix.texi (Messaging Home Services): Fix. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Blake Shaw
2023-05-09services: guix-build-coordinator: Support extra environment vars....I'm looking at this because I need to do some debugging of Guile's GC, and there are some useful environment variables for that, but it should be generally useful. * gnu/services/guix.scm (guix-build-coordinator-configuration-extra-environment-variables): New procedure. (guix-build-coordinator-shepherd-services): Pass the environment variables to the shepherd. * doc/guix.texi (Guix Services): Document it. Christopher Baines
2023-05-08Partly reinstate "doc: Update all menus."...This partly reinstates commit 9719d7d ("doc: Update all menus."), omitting the hunk touching doc/contributing.texi. * doc/guix.texi: Update all menus. Maxim Cournoyer
2023-05-07Revert "doc: Update all menus."...This reverts commit 9719d7d2b0733c57e30bff3180ff0fa25c34c66f. It breaks Guix pull, building the 'guix-manual' for reasons that currently escape me. Maxim Cournoyer
2023-05-07doc: Update all menus....Automated via 'M-x texinfo-all-menus-update' in Emacs, and dropping the *Contributing menu removal, which is erroneously removed because defined in a different Texinfo file. * doc/guix.texi: Update all menus. * doc/contributing.texi (Submitting Patches): Likewise. Maxim Cournoyer
2023-05-07doc: Add some information/recommendation regarding --sysconfdir....* doc/contributing.texi (Building from Git): Mention sysconfdir along localstatedir. * doc/guix.texi (Requirements): Likewise. Maxim Cournoyer
2023-05-06doc: Use G-Expressions for package definition example....* doc/guix.texi (Build Phases): Use G-Expressions for example. Co-authored-by: Nicolas Goaziou <mail@nicolasgoaziou.fr> Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-05-06doc: cookbook: Remove outdated section about GUIX_PACKAGE_PATH....The section insisted on GUIX_PACKAGE_PATH, mentioned version 0.16, and didn't say much about channels, which made it look obsolete. * doc/guix-cookbook.texi (GUIX_PACKAGE_PATH): Remove section. (Guix channels): Rename to... (Channels): ... this. Merge most of the explanations previously in the GUIX_PACKAGE_PATH section. Say more about channels and add cross-references. Ludovic Courtès
2023-05-04transformations: Add '--with-configure-flag'....* guix/transformations.scm (transform-package-configure-flag): New procedure. (%transformation-options, %transformation-options) (show-transformation-options-help/detailed): Add it. * tests/transformations.scm ("options->transformation, with-configure-flag"): New test. * doc/guix.texi (Package Transformation Options): Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Sarthak Shah
2023-05-01doc: Simplify contributing section by automating git configuration....Fixes <https://issues.guix.gnu.org/58813>. No longer suggests to splice the output of etc/teams.scm commands into the 'git send-email' command line; this is now transparently handled by the Git configuration, which is also automatic. * doc/contributing.texi (Configuring Git): Streamline section, now automated via Automake. (Sending a Patch Series): Do not specify options configured as default by the above. Prefer long option names, for readability. (Teams): Rewrite the examples to use --header-cmd. (Commit Access): Refer to the Configuring Git section instead of detailing manual steps. Maxim Cournoyer
2023-04-30doc: Add --sysconfdir=/etc to the recommended ./configure....* doc/contributing.texi (Building from Git): Add --sysconfdir=/etc to the recommended ./configure invocation. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Josselin Poiret
2023-04-25services: tor: Deprecate 'tor-hidden-service' procedure....Due to (now renamed) 'hidden-service' record type not being exported, the only way Onion services (formely hidden services) could have worked is through the now deprecated 'tor-hidden-service' procedure. This commit updates the Tor service documentation, corrects some inconsistently named accessors in <tor-configuration> record-type, renames and refactors tor-hidden-service-configuration to tor-onion-service-configuration using define-configuration and also exports it, allowing Onion services to be configured directly within a <tor-configuration> record. Lastly, it also deprecates the 'tor-hidden-service' procedure. * doc/guix.texi (Networking Services): Substitute mentions of “Hidden services” with “Onion Services”. Add a Tor Onion service configuration example. Document <tor-onion-service-configuration>. Remove mention of 'tor-hidden-service' procedure. * gnu/services/networking.scm: Export tor-configuration-tor, tor-configuration-config-file, tor-configuration-hidden-services, tor-configuration-socks-socket-type, tor-configuration-control-socket-path, tor-onion-service-configuration, tor-onion-service-configuration?, tor-onion-service-configuration-name, tor-onion-service-configuration-mapping. (<tor-configuration>)[control-socket?]: Rename accessor. (<hidden-service>): Replace with … (<tor-onion-service-configuration>): … this. (tor-configuration->torrc): Update record-type name. (tor-activation): Ditto. (tor-hidden-service-type): Remove variable. (tor-hidden-service): Deprecate procedure. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-04-23Merge remote-tracking branch 'origin/master' into core-updatesAndreas Enge
2023-04-23refresh: Support select packages SUBSET by module name....* guix/scripts/refresh.scm (%options): Support '--select module:NAME'. (show-help): Adjust accordingly. (options->update-specs): Honor the module passed by '--select'. * doc/guix.texi (Invoking guix refresh): Document it. 宋文武
2023-04-22Merge remote-tracking branch 'origin/master' into core-updatesAndreas Enge
2023-04-21doc: Update openssh-host documentation....* doc/guix.texi (Secure Shell): Update openssh-host documentation to match the code. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Saku Laesvuori
2023-04-21home: services: openssh: Add configuration option for jump proxies...Add a new 'proxy' field to openssh-host to allow ProxyCommand or ProxyJump, but not both, to be configured. Configuring both would cause the serialization order to determine which one is used. Deprecate the 'proxy-command' field because the 'proxy' field replaces it. * gnu/home/services/ssh.scm (proxy-jump->string, proxy-command-or-jump-list?, serialize-proxy-command-or-jump-list, sanitize-proxy-command): New procedure. (proxy-jump, proxy-command): New record type. (openssh-host)[proxy-command]: Mark field as deprecated because OpenSSH can't have ProxyCommand and ProxyJump configured at the same time. * doc/guix.texi (Secure Shell): Update to match the changes to the service. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Saku Laesvuori
2023-04-21services: syslog: Add a reload action....* gnu/services/base.scm (syslog-service-type) [actions]: Add a reload action. * doc/guix.texi (Base Services): Document it. Maxim Cournoyer
2023-04-14Merge branch 'master' into core-updates....Conflicts: gnu/local.mk gnu/packages/build-tools.scm gnu/packages/certs.scm gnu/packages/check.scm gnu/packages/compression.scm gnu/packages/cups.scm gnu/packages/fontutils.scm gnu/packages/gnuzilla.scm gnu/packages/guile.scm gnu/packages/ibus.scm gnu/packages/image-processing.scm gnu/packages/linux.scm gnu/packages/music.scm gnu/packages/nss.scm gnu/packages/pdf.scm gnu/packages/python-xyz.scm gnu/packages/qt.scm gnu/packages/ruby.scm gnu/packages/shells.scm gnu/packages/tex.scm gnu/packages/video.scm gnu/packages/vulkan.scm gnu/packages/web.scm gnu/packages/webkit.scm gnu/packages/wm.scm Maxim Cournoyer
2023-04-13doc: Fix various typos....* doc/guix.texi: Fix typos. Florian Pelz
2023-04-11services: nginx: Make logging level configurable....* gnu/services/web.scm (<nginx-configuration>)[log-level]: New field. (assert-valid-log-level): New procedure. (default-nginx-config): Make log-level configurable. * doc/guix.texi (Web Services): Document it. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Bruno Victal
2023-04-10doc: Regarding SSL certs, clarify when we write about Guix System....Rationale: Even though the section 'X.509 Certificates' is part of the System Configuration chapter, readers might also come here from a cross-reference when reading about Application Setup on a foreign distro. * doc/guix.texi (System Configuration)[X.509 Certificates]: Clarify. Florian Pelz
2023-04-08home: Add gpg-agent service....* gnu/home/services/gnupg.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * doc/guix.texi (GNU Privacy Guard): New node. (Secure Shell): Link to it. Ludovic Courtès
2023-04-06environment: Add '--nesting'....* guix/scripts/environment.scm (show-environment-options-help) (%options): Add '--nesting'. (options/resolve-packages): Handle it. (launch-environment/container): Add #:nesting? and honor it. [nesting-mappings]: New procedure. (guix-environment*): Add support for '--nesting'. * guix/scripts/shell.scm (profile-cached-gc-root): Special-case 'nesting?'. * tests/guix-environment-container.sh: Test it. * doc/guix.texi (Invoking guix shell): Document it. Ludovic Courtès
2023-04-03doc: Add a reference to a page explaining consensus decision making....This is to make explicit something which until now had always been implicit. * doc/contributing.texi (Commit Access): Mention that committers are expected to employ consensus decision making. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Maxim Cournoyer
2023-04-02services: mympd: Use records for user and group fields....* gnu/services/audio.scm (%mympd-user, %mympd-group) (mympd-user-sanitizer, mympd-group-sanitizer): New variables. (mympd-configuration)[user]: Use user-account as value type. Sanitize via mympd-user-sanitizer. [group]: Use user-group as value type. Sanitize via mympd-group-sanitizer. (mympd-serialize-configuration): Adjust accordingly. (mympd-accounts): Likewise. * doc/guix.texi (Audio Services)[myMPD]: Likewise. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> Bruno Victal
2023-04-02services: mpd: Use proper records for user and group fields....Deprecate using strings for these fields and prefer user-account (resp. user-group) instead to avoid duplication within account-service-type. Fixes #61570 <https://issues.guix.gnu.org/61570>. * gnu/services/audio.scm (%mpd-user, %mpd-group) (mpd-serialize-user-account, mpd-serialize-user-group) (mpd-user-sanitizer, mpd-group-sanitizer): New variables. (mpd-configuration)[user]: Use user-account as value type. Sanitize via mpd-user-sanitizer. [group]: Use user-group as value type. Sanitize via mpd-group-sanitizer. (mpd-shepherd-service): Adjust accordingly. (mpd-accounts): Likewise. * doc/guix.texi (Audio Services)[Music Player Daemon]: Likewise. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> Bruno Victal
2023-04-02services: configuration: Add user-defined sanitizer support....This changes the 'custom-serializer' field into a generic 'extra-args' field that can be extended to support new literals. Within extra-args, the literals 'sanitizer' and 'serializer' allow for user-defined sanitization and serialization procedures respectively. The 'empty-serializer' was also added as a literal to be used as before. To prevent confusion between the new “explicit” style of specifying a sanitizer, and the old “implicit” style, the latter has been deprecated, and a warning is issued if it is encountered. * gnu/services/configuration.scm (define-configuration-helper): Rename 'custom-serializer' to 'extra-args'. Add support for literals 'sanitizer', 'serializer' and 'empty-serializer'. Rename procedure 'field-sanitizer' to 'default-field-sanitizer' to avoid syntax clash. Only define default field sanitizers if user-defined ones are absent. (normalize-extra-args): New variable. (<configuration-field>)[sanitizer]: New field. * doc/guix.texi (Complex Configurations): Document the newly added literals. * tests/services/configuration.scm: Add tests for the new literals. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> Bruno Victal
2023-03-30services: pam-limits-service-type: Deprecate file-like object support in favo......* doc/guix.texi (Base Services): Document it. * gnu/local.mk: Register test. * gnu/services/base.scm (pam-limits-service-type): Accept both lists and file-like objects. Deprecate file-like object support. * gnu/tests/pam.scm: New file. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-03-30services: base: Deprecate 'pam-limits-service' procedure....* doc/guix.texi (Base Services): Replace pam-limits-service with pam-limits-service-type. * gnu/packages/benchmark.scm (python-locust)[description]: Update index anchor to manual. * gnu/services/base.scm (pam-limits-service-type): Set default value. (pam-limits-service): Deprecate procedure. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-03-26doc: Properly document 'replace' clause of 'modify-inputs'....* doc/guix.texi (Defining Package Variants): Add 'replace' to the reference of 'modify-inputs' clauses. Ludovic Courtès
2023-03-24services: mpd: Set PulseAudio-related variables....These variables are necessary for PulseAudio to work properly out-of-the-box for 'non-interactive' users. * doc/guix.texi (Audio Services): Update environment-variables field description for mpd-configuration data type. * gnu/services/audio.scm (mpd-configuration)[environment-variables]: Set PULSE_CLIENTCONFIG and PULSE_CONFIG environment variables to the system-wide PulseAudio configuration. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Bruno Victal
2023-03-24services: audio: Remove redundant list-of-string? predicate....Use list-of-strings? predicate defined in (gnu services configuration). * gnu/services/audio.scm (list-of-string?): Remove predicate. (mpd-serialize-list-of-string): Rename procedure to ... (mpd-serialize-list-of-strings): ... this. (mpd-configuration)[environment-variables]: Switch to list-of-strings. [endpoints]: Switch to maybe-list-of-strings. (mympd-ip-acl)[allow, deny]: Switch to list-of-strings. (mympd-serialize-configuration): Rename serialize-list-of-string to serialize-list-of-strings. * doc/guix.texi (Audio Services): Update it. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Bruno Victal