aboutsummaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAge
...
* doc: Simplify contributing section by automating git configuration.Maxim Cournoyer2023-05-01
| | | | | | | | | | | | | | | 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.
* doc: Add --sysconfdir=/etc to the recommended ./configure.Josselin Poiret2023-04-30
| | | | | | | * doc/contributing.texi (Building from Git): Add --sysconfdir=/etc to the recommended ./configure invocation. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* services: tor: Deprecate 'tor-hidden-service' procedure.Bruno Victal2023-04-25
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Merge remote-tracking branch 'origin/master' into core-updatesAndreas Enge2023-04-23
|\
| * refresh: Support select packages SUBSET by module name.宋文武2023-04-23
| | | | | | | | | | | | | | * 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.
* | Merge remote-tracking branch 'origin/master' into core-updatesAndreas Enge2023-04-22
|\|
| * doc: Update openssh-host documentation.Saku Laesvuori2023-04-21
| | | | | | | | | | | | | | * doc/guix.texi (Secure Shell): Update openssh-host documentation to match the code. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * home: services: openssh: Add configuration option for jump proxiesSaku Laesvuori2023-04-21
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * services: syslog: Add a reload action.Maxim Cournoyer2023-04-21
| | | | | | | | | | * gnu/services/base.scm (syslog-service-type) [actions]: Add a reload action. * doc/guix.texi (Base Services): Document it.
* | Merge branch 'master' into core-updates.Maxim Cournoyer2023-04-14
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
| * doc: Fix various typos.Florian Pelz2023-04-13
| | | | | | | | * doc/guix.texi: Fix typos.
| * services: nginx: Make logging level configurable.Bruno Victal2023-04-11
| | | | | | | | | | | | | | | | | | * 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>
| * doc: Regarding SSL certs, clarify when we write about Guix System.Florian Pelz2023-04-10
| | | | | | | | | | | | | | | | | | 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.
| * home: Add gpg-agent service.Ludovic Courtès2023-04-08
| | | | | | | | | | | | | | * 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.
| * environment: Add '--nesting'.Ludovic Courtès2023-04-06
| | | | | | | | | | | | | | | | | | | | | | | | | | * 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.
| * doc: Add a reference to a page explaining consensus decision making.Maxim Cournoyer2023-04-03
| | | | | | | | | | | | | | | | | | 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>
| * services: mympd: Use records for user and group fields.Bruno Victal2023-04-02
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
| * services: mpd: Use proper records for user and group fields.Bruno Victal2023-04-02
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * services: configuration: Add user-defined sanitizer support.Bruno Victal2023-04-02
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * services: pam-limits-service-type: Deprecate file-like object support in ↵Bruno Victal2023-03-30
| | | | | | | | | | | | | | | | | | | | | | | | favour for lists as service value. * 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>
| * services: base: Deprecate 'pam-limits-service' procedure.Bruno Victal2023-03-30
| | | | | | | | | | | | | | | | | | * 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>
| * doc: Properly document 'replace' clause of 'modify-inputs'.Ludovic Courtès2023-03-26
| | | | | | | | | | * doc/guix.texi (Defining Package Variants): Add 'replace' to the reference of 'modify-inputs' clauses.
| * services: mpd: Set PulseAudio-related variables.Bruno Victal2023-03-24
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * services: audio: Remove redundant list-of-string? predicate.Bruno Victal2023-03-24
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
| * doc: Mention Python 2 packages should not be added anymore.Maxim Cournoyer2023-03-23
| | | | | | | | | | * doc/contributing.texi (Python Modules): Mention Python 2 packages should not be added anymore.
| * services: Add fstrim-service-type.Bruno Victal2023-03-22
| | | | | | | | | | | | | | | | | | | | | | | | * gnu/services/linux.scm (fstrim-service-type): New variable. (fstrim-mcron-job, serialize-fstrim-configuration) (fstrim-serialize-list-of-strings, fstrim-serialize-boolean): New procedure. (mcron-time?): New predicate. (fstrim-configuration): New record. * doc/guix.texi (Linux Services): Document new fstrim-service-type. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Modified-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
| * doc: Document how to use specific package outputs in code.Karl Hallsby2023-03-21
| | | | | | | | | | | | | | | | * doc/guix.texi (Packages with Multiple Outputs): Provide an example of selecting a package's output in Scheme. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Modified-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
| * scripts: refresh: Add -T option.jgart2023-03-21
| | | | | | | | | | | | | | | | * doc/guix.texi (Invoking guix refresh): Document the -T option. * guix/scripts/refresh.scm (%options): Add the -T flag. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Modified-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
| * services: mcron: Add log-file and date-format fields.Bruno Victal2023-03-21
| | | | | | | | | | | | | | | | | | * doc/guix.texi (Scheduled Job Execution): Document it. * gnu/services/mcron.scm (mcron-configuration)[log-file, date-format]: New field. (mcron-shepherd-services): Add log-file and date-format support. Use file-append instead of string-append. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
| * services: mcron: Restyle mcron-configuration.Bruno Victal2023-03-21
| | | | | | | | | | | | | | | | * doc/guix.texi (Scheduled Job Execution): Sync doc with source. * gnu/services/mcron.scm (mcron-configuration): Restyle. [log-format]: Fix incorrectly formatted text. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
| * doc: Clarify special-files-service-type expected value.Bruno Victal2023-03-21
| | | | | | | | | | | | | | * doc/guix.texi (Services, Base Services): Clarify special-files-service-type expected value. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com>
* | Merge remote-tracking branch 'origin/master' into core-updatesAndreas Enge2023-03-20
|\|
| * services: dict: Deprecate 'dicod-service' procedure.Bruno Victal2023-03-17
| | | | | | | | | | | | | | * doc/guix.texi (Miscellaneous Services): Remove 'dicod-service' mention. * gnu/services/dict.scm (dicod-service): Deprecate procedure. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * home: services: Add home-xmodmap-service-type.conses2023-03-17
| | | | | | | | | | | | | | | | | | | | * gnu/home/services/desktop.scm (home-xmodmap-service-type) (home-xmodmap-configuration): New variables; (serialize-xmodmap-configuration) (xmodmap-shepherd-service): New procedures; * doc/guix.texi (Desktop Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * doc: Use 'mount --rbind' for chroot instructions.Maxim Cournoyer2023-03-17
| | | | | | | | | | | | | | | | | | | | | | This was reported by a user in #guix. It's at least necessary for /sys, to have the /sys/firmware/efivars location available insinde the chroot when using an UEFI system. * doc/guix.texi (Chrooting into an existing system): Replace --bind argument with --rbind Suggested-by: Josselin Poiret <dev@jpoiret.xyz>
| * home: services: ssh-agent: Handle setting of SSH_AUTH_SOCK.Jan (janneke) Nieuwenhuizen2023-03-17
| | | | | | | | | | | | | | | | | | * gnu/home/services/ssh.scm (home-ssh-agent-environment-variables): New procedure. (home-ssh-agent-service-type): Use it as ahome-environment-service type extension. * doc/guix.texi (Secure Shell): Remove advice about, and examples of setting SSH_AUTH_SOCK.
| * doc: Use @defvar instead of @defvr for Scheme variables.Jan (janneke) Nieuwenhuizen2023-03-16
| | | | | | | | | | | | | | | | | | | | Suggested by mirai via IRC, see also https://issues.guix.gnu.org/60634 * doc/guix.texi (Build Systems) (Secure Shell) (Messaging Home Services) (Media Home Services): Use @defvar instead of @defvr for Scheme variables.
| * home: services: ssh-agent: Remove host-side use of (shepherd support).Ludovic Courtès2023-03-16
| | | | | | | | | | | | | | | | | | | | | | This is a followup to 2c2f382e757d5eef39e8460a20ac75a1b1f8b22e, which inadvertently pulled in (shepherd support) on the host side. * gnu/home/services/ssh.scm (<home-ssh-agent-configuration>)[socket-directory]: Change value to a gexp. (home-ssh-agent-services): Change 'socket-file' and 'command' to a gexp. Add 'modules' field to 'shepherd-service'. * doc/guix.texi (Secure Shell): Adjust accordingly.
| * gnu: home: services: Add home-kodi-service-type.Jan (janneke) Nieuwenhuizen2023-03-16
| | | | | | | | | | | | | | * gnu/home/services/media.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * po/guix/POTFILES.in: Likewise. * doc/guix.texi (Media Home Services): Document it in new subsection.
| * gnu: home: services: Add home-znc-service-type.Jan (janneke) Nieuwenhuizen2023-03-16
| | | | | | | | | | | | | | * gnu/home/services/messaging.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * po/guix/POTFILES.in: Likewise. * doc/guix.texi (Messaging Home Services): Document it in new subsection.
| * gnu: home: services: Add home-ssh-agent-service-type.Jan (janneke) Nieuwenhuizen2023-03-16
| | | | | | | | | | | | | | * gnu/home/services/ssh.scm: (<home-ssh-agent-configuration>): New type. (home-ssh-agent-services): New procedure. (home-ssh-agent-service-type): New variable. * doc/guix.texi (Secure Shell): Document it.
| * doc: Document 'shebang' for 'guix shell'.Simon Tournier2023-03-16
| | | | | | | | | | | | | | * doc/guix.texi (Invoking guix shell): Add a note mentioning how to use 'shebang'. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
| * home: services: Add home-unclutter-service-type.conses2023-03-16
| | | | | | | | | | | | | | | | | | * gnu/home/services/desktop.scm (home-unclutter-configuration) (home-unclutter-service-type): New variables; (home-unclutter-shepherd-service): New procedure; * doc/guix.texi (Desktop Services): Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * doc: Use @defmac and @defspec for macros.Bruno Victal2023-03-13
| | | | | | | | | | | | | | | | * doc/guix.texi (package Reference, Defining Package Variants) (Build Utilities, The Store Monad, G-Expressions, operating-system Reference) (Service Reference, Complex Configurations): Use @defmac and @defspec for macros. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * doc: Use @defun for procedures.Bruno Victal2023-03-13
| | | | | | | | | | | | | | | | | | | | | | | | | | * doc/guix.texi (Inferiors, Defining Packages, package Reference) (origin Reference, Defining Package Variants, Writing Manifests) (Build Utilities, Search Paths, The Store, Derivations, The Store Monad) (G-Expressions, File Systems, Keyboard Layout, Base Services, X Window) (Desktop Services, File-Sharing Services, Web Services, Virtualization Services) (Version Control Services, Miscellaneous Services, Initial RAM Disk) (Bootloader Configuration, Service Reference, Shepherd Services) (Complex Configurations): Use @defun for procedures. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * doc: Fix incorrect @deffn usage for data types.Bruno Victal2023-03-13
| | | | | | | | | | | | * doc/guix.texi (Web Services): Fix incorrect @deffn usage for data types. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * doc: Fix incorrect @deffn usage for service-types.Bruno Victal2023-03-13
| | | | | | | | | | | | * doc/guix.texi (Networking Services): Fix incorrect @deffn usage for service-types. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * packages: 'package-input-rewriting/spec' ignores hidden packages.Ludovic Courtès2023-03-13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The primary motivation is to support things like: guix build guix --with-input=guile=guile-next without triggering a rebuild of (@@ (gnu packages commencement) guile-final) and similar things. It is also consistent with package name resolution on the command line: a package that cannot be named cannot be replaced. * guix/packages.scm (package-input-rewriting/spec)[rewrite]: When P is hidden, return it as-is. * tests/packages.scm ("package-input-rewriting/spec, hidden package"): New test. * doc/guix.texi (Defining Package Variants): Update. (Package Transformation Options): Update '--with-input' example.
| * doc: %desktop-services: Fix incorrect description.Bruno Victal2023-03-13
| | | | | | | | | | | | | | | | The Name Service Switch service is configured in operating-system. * doc/guix.texi (Desktop Services): Fix incorrect description for %desktop-services. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
| * services: dns: Extend dnsmasq-configuration.Sergey Trofimov2023-03-13
| | | | | | | | | | | | | | | | * gnu/service/dns.scm: (<dnsmasq-configuration>)[servers-file]: Add. (<dnsmasq-configuration>)[tftp-secure?]: Fix typo in parameter name. * doc/guix.texi: Document (<dnsmasq-configuration>)[servers-file]. Signed-off-by: Andrew Tropin <andrew@trop.in>
generated by cgit v1.2.3 (git 2.45.0) at 2024-11-24 11:15:21 +0000