summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Expand)Author
2023-02-08services: lightdm: Sync documentation with source....Table entry @item nodes cannot span multiple lines. * gnu/services/lightdm.scm (lightdm-gtk-greeter-configuration): Fix cursor-theme-size description. * doc/guix.texi (lightdm-service-type): Sync with source. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Bruno Victal
2023-02-09services: Add block-facebook-hosts-service-type....Deprecates %facebook-host-aliases in favour of using hosts-service-type service extensions. * gnu/services/networking.scm (block-facebook-hosts-service-type): New variable. (%facebook-host-aliases): Deprecate variable. * doc/guix.texi: Document it. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-02-09system: Deprecate hosts-file....* gnu/system.scm (operating-system-hosts-file): Deprecate procedure. (warn-hosts-file-field-deprecation): New procedure, helper for deprecated variable. (operating-system)[hosts-file]: Use helper to warn deprecated field. (local-host-aliases): Mark as deprecated. (local-host-entries): New procedure. (operating-system-default-essential-services, hurd-default-essential-services): Use hosts-service-type. Use '%operating-system-hosts-file' and 'local-host-entries'. (default-/etc/hosts): Remove procedure. (operating-system-etc-service): Remove hosts file. * doc/guix.texi (operating-system Reference) (Networking Services) (Virtualization Services): Rewrite documentation entries to use hosts-service-type. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-02-09services: Add hosts-service-type....* gnu/services/base.scm (<host>): New record type. (host): New procedure. (hosts-service-type): New variable. * doc/guix.texi (Service Reference): Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-02-05services: Add mympd-service-type....* gnu/services/audio.scm (mympd-service-type): New variable. * gnu/tests/audio.scm (%test-mympd): New variable. * doc/guix.texi: Document it. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> Bruno Victal
2023-02-05services: mpd: Do not hardcode environment variables....Services should not expect for XDG_RUNTIME_DIR to be set. Inferring from the past comment, this seemed to resolve an issue when the service was launched with an _interactive_ user-account, which tends to have this variable set by the login-manager. This is not the case for system accounts and setting this variable results in PulseAudio (launched by the same system user) failing to start since it attempts to use a nonexistent directory. Ideally, this service should have a home-service counterpart but the old behavior can be emulated by setting the environment-variables field to: (environment-variables (list (string-append "XDG_RUNTIME_DIR=/run/user/" (number->string (passwd:uid (getpwnam "myuser")))))) * gnu/services/audio.scm (mpd-configuration)[environment-variables]: New field. (mpd-shepherd-service)[start]: Use new field. * doc/guix.texi (Audio Services)[Music Player Daemon]: Document it. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> Bruno Victal
2023-02-05services: mpd: Refactor MPD service....Refactor mpd-service-type to support additional mpd.conf directives and move activation-service-extension into service constructor. * gnu/services/audio.scm (mpd-plugin, mpd-partition): New records. (mpd-serialize-boolean): Alias to and integrate logic into... (mpd-serialize-field): ... this. (mpd-serialize-list-of-string): New variable. (mpd-plugin?, mpd-partition?, list-of-string?, list-of-symbol?) (list-of-mpd-plugin?, list-of-mpd-partition?) (list-of-mpd-plugin-or-output?, port?): New variables. (mpd-file-name, mpd-service-activation): Remove variables. (mpd-configuration) [package, group, shepherd-requirement, log-file, log-level, music-directory] [playlist-directory, endpoints, database, partitions, neighbors, inputs] [archive-plugins, input-cache-size, decoders, resampler, filters] [playlist-plugins, extra-options]: New fields. [music-dir, playlist-dir, address]: Deprecate shorthand fields. [db-file, state-file, sticker-file, port, outputs]: Change admissible type. (mpd-shepherd-service) [actions]: New shepherd actions: 'reopen' and 'configuration'. [requirement]: Splice with 'shepherd-requirement' field. [start]: Use 'package' field. Remove #:log-file parameter. Move activation-service extension into constructor. (mpd-accounts): Honor user and group names from configuration. (mpd-log-rotation): New procedure. (mpd-service-type)[extensions]: Add rottlog-service-type extension. Remove activation-service-type extension. (mpd-output-name, mpd-output-type, mpd-output-enabled?, mpd-output-format) (mpd-output-tags?, mpd-output-always-on?, mpd-output-mixer-type) (mpd-output-replay-gain-handler, mpd-output-extra-options) (mpd-plugin-plugin, mpd-plugin-name, mpd-plugin-enabled?) (mpd-plugin-extra-options) (mpd-partition-name, mpd-partition-extra-options) (mpd-configuration-package, mpd-configuration-user) (mpd-configuration-group, mpd-configuration-shepherd-requirement) (mpd-configuration-log-file, mpd-configuration-log-level) (mpd-configuration-music-directory, mpd-configuration-music-dir) (mpd-configuration-playlist-directory, mpd-configuration-playlist-dir) (mpd-configuration-db-file, mpd-configuration-state-file) (mpd-configuration-sticker-file, mpd-configuration-default-port) (mpd-configuration-endpoints, mpd-configuration-address) (mpd-configuration-database, mpd-configuration-partitions) (mpd-configuration-neighbors, mpd-configuration-inputs) (mpd-configuration-archive-plugins, mpd-configuration-input-cache-size) (mpd-configuration-decoders, mpd-configuration-resampler) (mpd-configuration-filters, mpd-configuration-outputs) (mpd-configuration-playlist-plugins, mpd-configuration-extra-options): Export accessors. * doc/guix.texi (Audio Services)[Music Player Daemon]: Update documentation. Signed-off-by: Liliana Marie Prikler <liliana.prikler@gmail.com> Bruno Victal
2023-02-03services: nar-herder: Add cached compression support....* gnu/services/guix.scm (<nar-herder-cached-compression-configuration>): New record type. (nar-herder-configuration-cached-compressions, nar-herder-configuration-cached-compression-min-uses, nar-herder-configuration-cached-compression-workers, nar-herder-configuration-cached-compression-nar-source, nar-herder-cached-compression-configuration, nar-herder-cached-compression-configuration?, nar-herder-cached-compression-configuration-type, nar-herder-cached-compression-configuration-level, nar-herder-cached-compression-configuration-directory, nar-herder-cached-compression-configuration-directory-max-size): New procedures. * doc/guix.texi (Guix Services): Document this. Christopher Baines
2023-01-31home: services: fontutils: Add service value....* gnu/home/services/fontutils.scm (add-fontconfig-config-file): Add support for multiple paths; (home-fontconfig-service-type): Honor it; * doc/guix.texi (Fonts Services): Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Giacomo Leidi
2023-01-23doc: Substitute @deffn usage with @defvar for Scheme variables....* doc/guix.texi (Base Services) (Networking Setup) (Networking Services) (Printing Services) (Desktop Services) (Sound Services) (Database Services) (Mail Services) (Messaging Services) (File-Sharing Services) (Web Services) (DNS Services) (Power Management Services) (Virtualization Services) (Linux Services) (Miscellaneous Services): Substitute @deffn usage with @defvar for Scheme variables. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-01-23doc: Use @defvar instead of @defvr for Scheme variables....* doc/guix.texi (Build Systems) (Search Paths) (The Store) (The Store Monad) (File Systems) (Mapped Devices) (User Accounts) (Locales) (Base Services) (Scheduled Job Execution) (Log Rotation) (Networking Setup) (Networking Services) (Unattended Upgrades) (X Window) (Desktop Services) (Database Services) (Messaging Services) (Kerberos Services) (Web Services) (Certificate Services) (VPN Services) (Network File System) (Samba Services) (Power Management Services) (Audio Services) (Virtualization Services) (Linux Services) (Hurd Services) (Miscellaneous Services) (Setuid Programs) (Name Service Switch) (Initial RAM Disk) (Service Reference) (Shepherd Services) (Essential Home Services) (Mcron Home Service) (Power Management Home Services) (Shepherd Home Service) (Secure Shell) (Desktop Home Services) (Guix Home Services) (Supported Platforms) (Instantiate an Image) (image-type Reference): Use @defvar instead of @defvr for Scheme variables. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-01-23doc: Fix incorrect use of @defvar....* doc/guix.texi (Monitoring Services) (VNC Services) (Samba Services) (Game Services) (PAM Mount Service) (Guix Services): Fix incorrect use of @defvar. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-01-23doc: Document the 'release-monitoring-url' package property....* doc/guix.texi (Invoking guix refresh): Mention the 'release-monitoring-url' property. Ludovic Courtès
2023-01-22services: hpcguix-web: Provide default values....* gnu/services/web.scm (<hpcguix-web-configuration>)[specs]: Default to #f. (hpcguix-web-shepherd-service): Do not pass '--config' when SPECS is #f. (hpcguix-web-service-type)[default-value]: New field. * doc/guix.texi (Web Services): Adjust accordingly. Ludovic Courtès
2023-01-22gnu: hpcguix-web: Update to 0.3.0....* gnu/packages/web.scm (hpcguix-web): Update to 0.3.0. [inputs]: Add GUILE-SYNTAX-HIGHLIGHT. [arguments]: In 'wrap-program' phase, take guile-syntax-highlight into account. * gnu/tests/web.scm (%hpcguix-web-specs): Remove 'define'. * doc/guix.texi (Web Services): Adjust accordingly. Ludovic Courtès
2023-01-20doc: Fix Xvnc service example....Reported by bost on #guix (thank you!) * doc/guix.texi (VNC Services): Add the missing host argument in the SSH command example. Maxim Cournoyer
2023-01-18doc: Fix typo....* doc/guix.texi (Cross-Compilation): Replace "penaly" with "penalty". Replace "few users" with "fewer users". Maxim Cournoyer
2023-01-17doc: Use the right cross-reference command....* doc/guix.texi (Package Transformation Options): Use @pxref, not @ref. Ludovic Courtès
2023-01-16services: connman: Add iwd backend support....* gnu/services/networking.scm (connman-configuration)[iwd?]: New field. (connman-shepherd-service): Add iwd? logic, remove wpa-supplicant requirement. * doc/guix.texi: Add information about connman-configuration iwd? option. Co-authored-by: Andrew Tropin <andrew@trop.in> Signed-off-by: Andrew Tropin <andrew@trop.in> Declan Tsien
2023-01-16doc: Fix erroneous copyright line....* doc/guix.texi: Fix copyright line for Antero Mejr. Maxim Cournoyer
2023-01-16scripts: repl: Add -i, --interactive flag....* guix/scripts/repl.scm (%options): Add -i, --interactive flag. (guix-repl): Honor -i, --interactive flag. * doc/guix.texi (Invoking guix repl): Add documentation for -i, --interactive. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Antero Mejr
2023-01-16scripts: repl: Add --list-types flag....* guix/scripts/repl.scm (%options): Add --list-types. * doc/guix.texi (Invoking guix repl): Add documentation for --list-types. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Antero Mejr
2023-01-16transformations: Add '--with-version'....This is a followup to 8aeccc6240ec45f0bc7bed655e0c8149ae4253eb. * guix/transformations.scm (package-with-upstream-version): New procedure. (transform-package-latest)[package-with-latest-upstream]: Remove. Use 'package-with-upstream-version' instead. (transform-package-version): New procedure. (%transformations, %transformation-options) (show-transformation-options-help/detailed): Add '-with-version'. * tests/transformations.scm ("options->transformation, with-version"): New test. * doc/guix.texi (Package Transformation Options): Document '--with-version'. (Defining Package Variants): Mention it. Ludovic Courtès
2023-01-15services: greetd: Add 'source-profile?' configuration field....* gnu/services/base.scm (<greetd-terminal-configuration>)[source-profile?]: New field. (make-greetd-terminal-configuration-file): Serialize new field to configuration file. * doc/guix.texi (Base Services): Document it. Jelle Licht
2023-01-14gnu: services: Add joycond-service....* gnu/services/games.scm (joycond-configuration): New configuration type. (joycond-shepherd-service): New procedure. (joycond-service-type): New variable. * doc/guix.texi (Game Services): Document it. David Thompson
2023-01-11doc: Clarify how to use the #:go key of go-build-system....This is a followup to commit 9ec62d1b9c55104f9ab81b95d82988c627a23415. * doc/guix.texi (Build Systems): Clarify the '#:go' key. Leo Famulari
2023-01-11doc: Document the #:go key of the Go build system....* doc/guix.texi (Build Systems): Document '#:go'. Leo Famulari
2023-01-11doc: contributing: Note '-v REVISION' bug in 'git send-email'....* doc/contributing.texi ("Submitting Patches")["Sending a Patch Series"]: Note that a bug in 'git send-email' means '-v REVISION' (with a space) will not work. Signed-off-by: Christopher Baines <mail@cbaines.net> (
2023-01-11doc: contributing: Tweak the Commit Policy....Add more examples of when it can be appropriate to push changes without review, as I think this can be appropriate in the case of trivial changes (as mentioned before), but also non-trivial fixes. No longer suggest pushing simple new packages or package upgrades (that don't cause lots of rebuilds) without sending to guix-patches. Now there's some automation for testing changes sent to guix-patches, sending changes there before pushing can mean that more rigorous testing takes place and help speed up substitutes becoming available. This is true, even if no human review takes place. Only suggest waiting one week for review for simpler changes, wait two weeks for more significant changes. Also, reorder some of the information in this section so it's grouped together better. * doc/contributing.texi (Commit Policy): Tweak. Signed-off-by: Christopher Baines <mail@cbaines.net> Christopher Baines
2023-01-10doc: Fix documentation typo....* doc/guix.texi (VNC Services): Fix typo. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> jgart
2023-01-10services: unattended-upgrade: Add 'operating-system-expression' field....* gnu/services/admin.scm (<unattended-upgrade-configuration>) [operating-system-expression]: New field. (unattended-upgrade-mcron-jobs): Honor it. * doc/guix.texi (Unattended Upgrades): Document it. Co-authored-by: Ludovic Courtès <ludo@gnu.org> Giacomo Leidi
2023-01-10services: git-daemon: Deprecate 'git-daemon-service' procedure....* gnu/services/version-control.scm (git-daemon-service): Define with 'define-deprecated' * doc/guix.texi (Version Control Services): Replace with 'git-daemon-service-type' Signed-off-by: Ludovic Courtès <ludo@gnu.org> Bruno Victal
2023-01-08doc: Fix <openntpd-configuration> openntpd default....* doc/guix.texi (Networking Services): <openntpd-configuration>'s openntpd field takes a package: it does not default to a FILE-APPEND call. Tobias Geerinckx-Rice
2023-01-09doc: cookbook: Add "Installing Guix on a Cluster" chapter....This is derived from the article at <https://hpc.guix.info/blog/2017/11/installing-guix-on-a-cluster/>, with clarifications and updates. * doc/guix-cookbook.texi (Installing Guix on a Cluster): New chapter. Ludovic Courtès
2023-01-09services: base: Add environment support to guix-configuration....* gnu/services/base.scm (<guix-configuration>)[extra-env]: New field. (guix-shepherd-service): Honor it. * doc/guix.texi (Base Services): Document it. Mathieu Othacehe
2023-01-07Revert "services: base: Add extra-env support to guix-configuration."...This reverts commit 78a9b4f996ba18b4460ba380b87e9538007c27e0. It was pushed by error, while not reviewed yet. Mathieu Othacehe
2023-01-07services: base: Add extra-env support to guix-configuration....* gnu/services/base.scm (<guix-configuration>)[extra-env]: New field. (guix-shepherd-service): Honor it. * doc/guix.texi (Base Services): Document it. Mathieu Othacehe
2023-01-06doc: cookbook: Remove 404 link to mitpress.mit.edu....* doc/guix-cookbook.texi (A Scheme Crash Course): Remove 404 link to mitpress.mit.edu. Ludovic Courtès
2023-01-05doc: Introduce using swap space for hibernation, with examples....* doc/guix.texi (Swap Space): Add a concise introduction to hibernation and specifying a swap space to the kernel to make resume work. Mention space requirements and the need of an offset for swap files. Include a trivial example on how to set up a mapped swap volume for hibernation and another one for a swap file, including how to compute the file offset. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Ivan Vilata-i-Balaguer
2023-01-05home: services: environment-variables: Add support for literal strings....* gnu/home/services.scm (<literal-string>): New record type. (environment-variable-shell-definitions): Split 'shell-quote' into 'quote-string' and 'shell-double-quote'. Add 'shell-single-quote'. Add clause for 'literal-string' records. * tests/guix-home.sh: Test it. * doc/guix.texi (Essential Home Services): Document it. Ludovic Courtès
2023-01-03doc: Fix broken link for go-build-system....* doc/guix.texi (Build Systems): Fix broken link for go-build-system. Signed-off-by: Maxim Cournoyer <maxim.cournoyer@gmail.com> Bruno Victal
2022-12-31import/cran: Allow custom license prefix....* guix/import/cran.scm (string-licenses): Add license-prefix argument. (string->license): Ditto. (description->package): Ditto. (cran->guix-package): Ditto. (cran-recursive-import): Ditto. * guix/scripts/import/cran.scm (%options): Add new option -p/--license-prefix. (show-help): Document it. (parse-options): Pass it to importer. * doc/guix.texi (Invoking guix import): Document it. Lars-Dominik Braun
2022-12-29doc: Give example of when to use describe in .guix-channel file....* doc/guix.texi (Package Modules in a Sub-directory): Mention "guix deploy" files as an example. Signed-off-by: Ricardo Wurmus <rekado@elephly.net> Karl Hallsby
2022-12-29doc: Describe format of channel that uses directory field....* doc/guix.texi (Package Modules in a Sub-directory): Explain that directory must be the module root. Karl Hallsby
2022-12-28doc: Update expired URL....* doc/guix.texi (DNS Services): Update knot-resolver documentation link. Marius Bakke
2022-12-26doc: Describe how to update to a specific version....* doc/guix.texi (Invoking guix refresh): Describe how to update to a specific version. Hartmut Goebel
2022-12-26gnu: services: Fix bluetooth-service docstring....* gnu/services/desktop.scm (bluetooth-service): Sync docstring with info, remove mention to group not really needed to access D-Bus service. * doc/guix.texi (Desktop Services): Also remove mention to group here. Signed-off-by: Ludovic Courtès <ludo@gnu.org> Ivan Vilata i Balaguer
2022-12-25services: wireguard: Allow specifying pre-shared keys....* gnu/services/vpn.scm (<wireguard-peer>)[preshared-key]: New field. * doc/guix.texi (VPN Services): Document it. Signed-off-by: Mathieu Othacehe <othacehe@gnu.org> Timo Wilken
2022-12-18doc: Fix typo....* doc/contributing.texi (Sending a Patch Series): Fix e-mail address of <guix-patches@gnu.org>. Reported by Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>. Tobias Geerinckx-Rice
2022-12-23doc: Wrap $localstatedir in Texinfo syntax....* doc/guix.texi (Limitations): Use @file syntax. Ricardo Wurmus