summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2020-05-05gnu: Add AutoSSH service.pinoaffe
* gnu/services/ssh.scm (<autossh-configuration>): New record type. (autossh-service-type): New variable. (autossh-service-activation, autossh-file-name): New procedures. * doc/guix.texi (Networking Services): Document this. Signed-off-by: Oleg Pykhalov <go.wigust@gmail.com>
2020-05-04doc: Remove prompt from X.509 examples.Ludovic Courtès
* doc/guix.texi (X.509 Certificates): Remove leading "$".
2020-05-04doc: Add "Packages for C Development" section.Ludovic Courtès
Suggested by Bruno Haible <bruno@clisp.org> in <https://bugs.gnu.org/41038>. * doc/guix.texi (Packages for C Development): New node. (Application Setup)[The GCC toolchain]: Empty and refer to it.
2020-05-04doc: Recommend against SHA1 OpenPGP signatures.Ludovic Courtès
* doc/contributing.texi (Commit Access): Recommend against SHA1 signatures.
2020-05-04doc: Document committer authorization.Ludovic Courtès
* doc/contributing.texi (Commit Access): Add instructions for authorizing committers.
2020-05-02Merge branch 'master' into core-updatesMarius Bakke
2020-05-02doc: Fix building the cookbook.Björn Höfling
Fixes <https://debbugs.gnu.org/cgi/bugreport.cgi?bug=40803>. Reported by "operator.name" <operator.name@protonmail.com>. * doc/build.scm (%languages): Add smaller list for the cookbook. (syntax-highlighted-html): Adapt regexp for mono-node files to include the cookbook.
2020-05-02services: dnsmasq: Support the --address flag.Pierre Langlois
Introduce a new `addresses' field that translates to passing `--address=' multiple times to dnsmasq. * gnu/services/dns.scm (<dnsmasq-configuration>): Add an addresses field. (dnsmasq-shepherd-service): Match the addresses field and translate it to multiple '--address=' flags. * doc/guix.texi (DNS Services): Document it. Signed-off-by: 宋文武 <iyzsong@member.fsf.org>
2020-05-01doc: Update initrd section to refer to the right Guile variable.Marius Bakke
This is a follow-up to commit 57833803b446484b6f413fb883b2156933c38639. * doc/guix.texi (Initial RAM Disk): Refer to "%guile-3.0-static-stripped" instead of "%guile-static-stripped".
2020-05-01doc: Move 'Dictionary Service' under 'Miscellaneous Services'.Brice Waegeneire
* doc/guix.texi (Dictionary Service): Renamed to singular and changed from 'subsubsection' to 'subheading'. Signed-off-by: Mathieu Othacehe <m.othacehe@gmail.com>
2020-05-01doc: Replace section 'Early OOM service' by 'Linux Services'.Brice Waegeneire
* doc/guix.texi (Linux Services): Changed from 'subsubheading' to 'subsection'. (Early OOM Service, Kernel Module Loader Service): Moved under 'Linux Services'. Signed-off-by: Mathieu Othacehe <m.othacehe@gmail.com>
2020-05-01system: Blacklist usbmouse kernel module in default kernel-arguments.Florian Pelz
This avoids a race with the bcm5974 kernel module. Fixes <https://bugs.gnu.org/35574>. * gnu/system.scm (%default-modprobe-blacklist): New variable. (<operating-system>)[kernel-arguments]: Default to ... (%default-kernel-arguments): ... this new variable. * doc/guix.texi (operating-system Reference): Document the change.
2020-04-30doc: Bootloader Configuration: Fix an obsolete example.Leo Famulari
Reported by rawmat on #guix. * doc/guix.texi (Bootloader Configuration): Replace 'grub-configuration' with 'bootloader-configuration'.
2020-04-30doc: cookbook: Rename stumpwm package to current state.Marcin Karpezo
* doc/guix-cookbook.texi (StumpWM): Rename STUMPWM package to current state. Signed-off-by: Oleg Pykhalov <go.wigust@gmail.com>
2020-04-28doc: Mention that PulseAudio service overrides user configuration.Diego Nicola Barbato
* doc/guix.texi (Sound Services): Add a warning that 'pulseaudio-service-type' overrides per-user configuration files in '~/.config/pulse'. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-04-27doc: Update url to singularity before link rot occurs.operator.name
* doc/guix.texi: Update url to singularity before link rot occurs. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-04-27doc: guix: Fix grammar in "Debugging Build Failures"TomZ
* doc/guix.texi (Debugging Build Failures): Fix grammar. Signed-off-by: Jakub Kądziołka <kuba@kadziolka.net>
2020-04-25doc: guix: Fix some markup.Nicolas Goaziou
* doc/guix.texi (Build Systems): (Base Services): (X Window): (Printing Services): (Mail Services): (Messaging Services): (LDAP Services): (Virtualization Services): (Version Control Services): Use @samp, @code and double quotes where appropriate.
2020-04-25doc: cookbook: Fix quotes.Nicolas Goaziou
* doc/guix-cookbook.texi (Basic setup with manifests): (Default profile): (The benefits of manifests): Use proper quotes in regular texts.
2020-04-24doc: cookbook: Use @file for file names and extensions.Nicolas Goaziou
* doc/guix-cookbook.texi (@samp{GUIX_PACKAGE_PATH}): (Extended example): (Setting up a bind mount): (Basic setup with manifests): (Default profile): Use @file instead of @samp or @code for file names and extensions.
2020-04-24doc: cookbook: Fix misuses of double spacing.Nicolas Goaziou
* doc/guix-cookbook.texi (Extended example): (StumpWM): (Basic setup with manifests): Prevent Texinfo from ending a sentence where it should not. (Setting up a bind mount): Add two spaces where needed.
2020-04-24doc: Ensure guix-daemon is built before creating guix-daemon.1.Marius Bakke
* doc/local.mk ($(srcdir)/%D%/guix-daemon.1): Depend on guix-daemon$(EXEEXT) instead of its source code.
2020-04-23build: Don't build man pages when cross-compiling.Ludovic Courtès
* configure.ac: Define 'CROSS_COMPILING' Automake conditional. * doc/local.mk (dist_man1_MANS): Wrap in "if !CROSS_COMPILING".
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.