summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)Author
2020-04-23doc: Build more man pages.Ludovic Courtès
* doc/local.mk (sub_commands_mans): Add guix-deploy.1, guix-time-machine.1, and guix-weather.1.
2020-04-22gnu: font-gnu-freefont: Add otf and woff font types.Raghav Gururajan
* gnu/packages/fonts.scm (font-gnu-freefont): Add otf and woff font types. * gnu/packages/genealogy.scm (gramps)[inputs]: Replace font-gnu-freefont-tff with font-gnu-freefont. * doc/guix.texi: Adjust a reference to the package. Signed-off-by: Leo Famulari <leo@famulari.name>
2020-04-22doc: cookbook: Explain how to use bind mounts.Matthew Brooks
* doc/guix-cookbook.texi (Setting up a bind mount): Add example. Signed-off-by: Leo Famulari <leo@famulari.name>
2020-04-22doc: Adjust @var vs. @code.Ludovic Courtès
* doc/guix.texi (Base Services): Adjust @var vs. @code. Use 'cons' instead of 'cons*' in example.
2020-04-22services: Add udev-rules-service helper.Brice Waegeneire
* doc/guix.texi (Base services): Add documentation for 'udev-rules-service'. Replace examples of 'udev-service-type' extension with 'udev-rules-service'. * gnu/services/base.scm (udev-rules-service): New procedure. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-04-22gexp: Add 'load-path?' field to <scheme-file>.Ludovic Courtès
* guix/gexp.scm (<scheme-file>)[load-path?]: New field. (scheme-file): Add #:set-load-path? and honor it. (scheme-file-compiler): Pass #:set-load-path? to 'gexp->file'. * doc/guix.texi (G-Expressions): Document it.
2020-04-21doc: Include *.json files in the source.Ludovic Courtès
This is a followup to c9f321e52a99dea93fcc099372ea0167150b9aac. * doc/build.scm (texinfo-manual-source)[build]: Add *.json to #$output.
2020-04-21packages: Recommend against the use of 'package-file'.Ludovic Courtès
* guix/packages.scm (package-file): Recommend against its use in the docstring. * doc/guix.texi (The Store Monad): Likewise.
2020-04-19services: Add 'simulated-wifi-service-type'.Ludovic Courtès
* gnu/services/networking.scm (simulated-wifi-shepherd-services): New procedure. (simulated-wifi-service-type): New variable. * doc/guix.texi (Networking Services): Document it.
2020-04-19services: Add 'hostapd-service-type'.Ludovic Courtès
* gnu/services/networking.scm (<hostapd-configuration>): New record type. (hostapd-configuration-file, hostapd-shepherd-services): New procedures. (hostapd-service-type): New variable. * doc/guix.texi (Networking Services): Document it.
2020-04-19doc: Make install script more prominent.Ludovic Courtès
Suggested by Steven vanZyl <rushsteve1@rushsteve1.us>. * doc/guix.texi (Binary Installation): Add @example showing how to download the script. Use "systemctl enable --now".
2020-04-17doc: Update nar decompression examples.mikadoZero
* doc/guix.texi (Invoking guix archive): Show /gzip URL. Add cross-reference to "Invoking guix challenge". (Invoking guix challenge): Show /lzip URL. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-04-17maint: Provide the configuration file in the VM image.Ludovic Courtès
This fixes a bug introduced in 362bcdb1b076c8c46f71781add56dfbe532736dc whereby the VM image would no longer contain /etc/config.scm, contrary to what the manual says. Reported by dbdude on #guix. * Makefile.am (release): Pass '--save-provenance' to 'guix system vm-image'. * doc/guix.texi (Running Guix in a VM): Adjust file name accordingly.
2020-04-17doc: Replace incorrect uses of @var with @code.Ludovic Courtès
@var is for meta-syntactic variables but it is used in some places for mere variables, which is incorrect and leads to inconsistent layout in PDF and HTML. * doc/guix.texi (package Reference, The Store Monad) (G-Expressions, operating-system Reference) (File Systems, Base Services, Log Rotation) (Networking Services, Invoking guix deploy): Replace incorrect uses of @var with @code.
2020-04-16doc: Document building and installing from JSON files.Ricardo Wurmus
* doc/guix.texi (Invoking guix package): Augment pargraphs for "--install-from-file". (Invoking guix build): Document building from JSON files. * doc/package-hello.json: New file. * doc/local.mk (EXTRA_DIST): Add it.
2020-04-16doc: Add dicod-service-type in Dictionary Services.R Veera Kumar
* doc/guix.texi (Miscellaneous Services): Add dicod-service-type in Dictionary Services. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-04-16doc: Remove bogus index entry.Ludovic Courtès
* doc/guix.texi (Build Systems): Remove bogus and redundant entry for 'copy-build-system'.
2020-04-15doc: Fix typo.Nicolas Goaziou
* doc/guix.texi (Running Guix in a VM): Add missing reference to `spice-vdagent-service' and misuse of @pxref.
2020-04-14doc: Fix typo.Brice Waegeneire
* doc/guix.texi (Web Services)[nginx-php-fpm-location]: Replace 'nginx-php-fpm-location' by 'nginx-php-location'. Signed-off-by: Christopher Baines <mail@cbaines.net>
2020-04-13doc: Improve anchor collection.Ludovic Courtès
This allows us to catch "operating_002dsystem-1", for instance. * doc/build.scm (syntax-highlighted-html)[build](anchor-id->key): Drop "-1" & co. from ID.
2020-04-13doc: Avoid invalid 'match' pattern in 'syntax-highlighted-html'.Ludovic Courtès
This is a followup to da9deba13d551e316f5a99a614834efa27ddc7d1. Last-minute modification of the 'match' pattern would lead to an error: "multiple ellipsis patterns not allowed at same level" * doc/build.scm (syntax-highlighted-html)[build](collect-anchors): Add 'worthy-entry?' procedure and use it instead of the unsupported pattern for ('dt ...).
2020-04-13doc: Emit hyperlinks in HTML output for @lisp snippets.Ludovic Courtès
This makes it easier to jump to the definition of a procedure or variable when looking at a code snippet. There can be false-positive because scoping rules are ignored, for example, but it should be a good approximation. * doc/build.scm (syntax-highlighted-html)[build](highlights->sxml*): Add 'anchors' parameter. Add clause for ('symbol text). (syntax-highlight): Add 'anchors' parameter. Wrap body in named let and use it in recursive calls. Pass ANCHORS to 'highlights->sxml*'. (underscore-decode, anchor-id->key, collect-anchors, html?): New procedures. (process-file): Add 'anchors' parameter. and honor it. Rewrite mono-node and multi-node HTML files separately.
2020-04-08doc: Mention HTTP/HTTPS proxy in the system installation instructions.Ludovic Courtès
* doc/guix.texi (Keyboard Layout and Networking and Partitioning): Mention 'herd set-http-proxy guix-daemon'.
2020-04-07services: guix: Add 'set-http-proxy' action.Ludovic Courtès
Fixes <https://bugs.gnu.org/25569>. Reported by Divan Santana <divan@santanas.co.za>. * gnu/services/base.scm (shepherd-set-http-proxy-action): New procedure. (guix-shepherd-service): Add 'actions' field. Change 'start' to a lambda; check the value of the "http_proxy" environment variable and add "http_proxy" and "https_proxy" to #:environment-variables as a function of that. * gnu/tests/base.scm (run-basic-test)["guix-daemon set-http-proxy action", "guix-daemon set-http-proxy action, clear"]: New tests. * doc/guix.texi (Base Services): Document it.
2020-04-06services: Add 'rottlog-service-type' to '%base-services'.Ludovic Courtès
* gnu/services/base.scm (%base-services): Add an instance of ROTTLOG-SERVICE-TYPE. * doc/guix.texi (Log Rotation): Mention that it's part of %BASE-SERVICES and change example.
2020-04-06doc: Make 'fc-cache -rv' instructions more prominent.Ludovic Courtès
* doc/guix.texi (Application Setup): Move the "fc-cache" instructions next to the Fontconfig paragraph and make the command more visible.
2020-04-06gnu: mumi: Update to 0.0.0-12.bb2fe92.Ricardo Wurmus
* gnu/packages/mail.scm (mumi): Update to 0.0.0-12.bb2fe92. [inputs]: Add guile-gcrypt, guile-redis, guile-webutils, mailutils. * gnu/services/web.scm (<mumi-configuration>): New record type. (mumi-configuration, mumi-configuration?, mumi-configuration-mumi, mumi-configuration-mailer?, mumi-configuration-sender, mumi-configuration-smtp): New procedures. (mumi-shepherd-services): Accept configuration; adjust start commands; add Shepherd service for mumi mailer. (mumi-service-type): Pass default configuration. * doc/guix.texi (Web Services): Update documentation.
2020-04-06system: Allow for comma-separated keyboard layouts.Ludovic Courtès
Reported by Florian Pelz <pelzflorian@pelzflorian.de>. * gnu/bootloader/grub.scm (keyboard-layout-file): Replace commas with hyphens in the first argument to 'computed-file'. * gnu/system/keyboard.scm (keyboard-layout->console-keymap): Likewise. * doc/guix.texi (Keyboard Layout): Add example.
2020-04-05gnu: Add kernel-module-loader-service.Brice Waegeneire
* doc/guix.texi (Linux Services): Add a new subsection and document the new service and its configuration. * gnu/services/linux.scm (kernel-module-loader-service-type): New type. (kernel-module-loader-shepherd-service): New procedure. * gnu/tests/linux-modules.scm (module-loader-program): Procedure removed. (modules-loaded?-program): New procedure. (run-loadable-kernel-modules-test): 'module-loader-program' procedure replaced by the new one. [os]: Use 'kernel-module-loader-service'. Signed-off-by: Danny Milosavljevic <dannym@scratchpost.org>
2020-03-30gnu: Add sbcl-stumpwm-ttf-fonts.Oleg Pykhalov
* gnu/packages/wm.scm (sbcl-stumpwm-ttf-fonts): New variable. * doc/guix-cookbook.texi (Customizing a Window Manager): Document SBCL-STUMPWM-TTF-FONTS installation and configuration.
2020-03-27services/nfs: Replace nfs-version with nfs-versions.Ricardo Wurmus
Instead of accepting a string for just one protocol version accept a list of supported versions. * gnu/services/nfs.scm (<nfs-configuration>)[nfs-version]: Remove field and replace... [nfs-versions]: ...with this new field. (nfs-shepherd-services): Pass as many "--nfs-version" options as there are supported versions. * doc/guix.texi (Network File System): Document nfs-versions.
2020-03-24doc: Document that a working environment for building Guix requires "--pure".Danny Milosavljevic
* doc/guix.texi (Invoking guix environment): Document that a working environment for building Guix requires "--pure".
2020-03-24doc: Fix typo in example.Naga Malleswari
* doc/guix.texi (Base Services)[file->udev-rule]: Correct misspelt "user-account". Signed-off-by: Danny Milosavljevic <dannym@scratchpost.org>
2020-03-24doc: Fix typo.Naga Malleswari
* doc/guix.texi (Invoking guix time-machine): Fix typo. Signed-off-by: Danny Milosavljevic <dannym@scratchpost.org>
2020-03-23doc: Fix typo in example.Brice Waegeneire
* doc/guix.texi (Invoking guix deploy): Fix example to use '%user' variable defined above. Signed-off-by: Mathieu Othacehe <m.othacehe@gmail.com>
2020-03-23doc: Add console-font-service-type to Base Services.John Soo
* doc/guix.texi (Base Services): Add console-font-service-type. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
2020-03-22system: Add kernel-loadable-modules to operating-system.Danny Milosavljevic
* gnu/system.scm (<operating-system>): Add kernel-loadable-modules. (operating-system-directory-base-entries): Use it. * doc/guix.texi (operating-system Reference): Document KERNEL-LOADABLE-MODULES. * gnu/build/linux-modules.scm (depmod): New procedure. (make-linux-module-directory): New procedure. Export it. * guix/profiles.scm (linux-module-database): New procedure. Export it. * gnu/tests/linux-modules.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * gnu/packages/linux.scm (make-linux-libre*)[arguments]<#:phases>[install]: Disable depmod. Remove "build" and "source" symlinks. [native-inputs]: Remove kmod.
2020-03-19doc: Update to reflect the current installation prefix of Emacs packages.Maxim Cournoyer
* doc/guix.texi (Application Setup)[Emacs Packages]: No longer mention the guix.d Elisp installation prefix. Do not treat the user profile specially, as it is not special anymore. (Build Systems): Document the correct Elisp installation prefix.
2020-03-18doc: Correctly state the size of the glibc-locales package.Leo Famulari
* doc/guix.texi (Application Setup): Give the correct size.
2020-03-18doc: Follow-up commit to f6b950319c.Maxim Cournoyer
* doc/guix.texi (Invoking guix deploy): Fix typo in example. Reported-by: Ludovic Courtès <ludo@gnu.org>
2020-03-17gnu: system: Export %sudoers-specification.Maxim Cournoyer
Exporting this variable allows reusing the default value of the `sudoers-file' field when configuring it. * gnu/system.scm (gnu): Export %sudoers-specification. * doc/guix.texi (Invoking guix deploy): Document an example, to use with 'guix deploy'.
2020-03-17doc: Fix typo in prosody configuration.Efraim Flashner
* doc/guix.texi (Messaging Services)[Prosody Service]: Switch 'cons' to 'cons*' in example prosody-service-type.
2020-03-16services: nginx: Fix broken default configuration.Tobias Geerinckx-Rice
* gnu/services/web.scm (nginx-configuration): Emit an empty events{} block by default. * doc/guix.texi (Web Services): Document it.
2020-03-15services/web: nginx-configuration: Add support for global directives.Ricardo Wurmus
* gnu/services/web.scm (<nginx-configuration>)[global-directives]: Add field. (emit-global-directive): New procedure. (default-nginx-config): Use it. * doc/guix.texi (Web Services): Document it.
2020-03-13doc: Update guidance about Python 2 package variants.Leo Famulari
* doc/contributing.texi (Python Modules): Don't recommend adding Python-2 package variants by default.
2020-03-13weather: Exit with non-zero when coverage is below 100%.Ludovic Courtès
* guix/scripts/weather.scm (report-server-coverage): Return the coverage ratio. (guix-weather): Exit if and only if each server's coverage is 1.
2020-03-12weather: Allow for multiple '--manifest' options.Ludovic Courtès
* guix/scripts/weather.scm (guix-weather)[package-list]: Account for all the 'manifest entries in OPTS. * doc/guix.texi (Invoking guix weather): Document it.
2020-03-12weather: Add '--display-missing'.Ludovic Courtès
* guix/scripts/weather.scm (report-server-coverage): Add #:display-missing? and honor it. (show-help, %options): Add "--display-missing". (guix-weather): Pass #:display-missing? to 'report-server-coverage'. * doc/guix.texi (Invoking guix weather): Document it.
2020-03-12gexp: Add 'with-parameters'.Ludovic Courtès
* guix/gexp.scm (<parameterized>): New record type. (with-parameters): New macro. (compile-parameterized): New gexp compiler. * tests/gexp.scm ("with-parameters for %current-system") ("with-parameters for %current-target-system") ("with-parameters + file-append"): New tests. * doc/guix.texi (G-Expressions): Document it.
2020-03-12doc: Fix description for "guix package -A".Danny Milosavljevic
* doc/guix.texi (Invoking guix package): Fix description for "guix package -A".