Commit graph

2036 commits

Author SHA1 Message Date
Brice Waegeneire
2f93615670
doc: Clarify 'git-http-configuration' description.
Fix <https://issues.guix.info/31780>.

* doc/guix.texi (Version Control Service): Extend
'git-http-configuration' description.
2020-05-06 11:03:43 +02:00
Jean-Baptiste Note
751d1f01e4
doc: cookbook: Fix sbcl-ttf-fonts package name.
* doc/guix-cookbook.texi (StumpWM): Adjust sbcl-ttf-fonts package name.

Signed-off-by: Marius Bakke <mbakke@fastmail.com>
2020-05-05 20:09:39 +02:00
Nicolas Goaziou
826c2eecbe
doc: Typographic improvements.
* doc/guix.texi (Networking Services): Use @var, @option, and @command when
appropriate.  Add two spaces after sentences.
2020-05-05 16:38:29 +02:00
pinoaffe
051f3254cd
gnu: Add AutoSSH service.
* 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-05 15:32:40 +03:00
Ludovic Courtès
9dbc7f50ab
doc: Remove prompt from X.509 examples.
* doc/guix.texi (X.509 Certificates): Remove leading "$".
2020-05-04 23:07:57 +02:00
Ludovic Courtès
1f14e25c19
doc: Add "Packages for C Development" section.
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-04 10:50:18 +02:00
Ludovic Courtès
4a84deda74
doc: Recommend against SHA1 OpenPGP signatures.
* doc/contributing.texi (Commit Access): Recommend against SHA1
signatures.
2020-05-04 09:56:14 +02:00
Ludovic Courtès
84133320b8
doc: Document committer authorization.
* doc/contributing.texi (Commit Access): Add instructions for
authorizing committers.
2020-05-04 09:56:13 +02:00
Björn Höfling
7c65fc378c
doc: Fix building the cookbook.
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-02 13:21:42 +02:00
Pierre Langlois
5a0b78e62b
services: dnsmasq: Support the --address flag.
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-02 13:00:24 +08:00
Brice Waegeneire
dc6eec77a5
doc: Move 'Dictionary Service' under 'Miscellaneous Services'.
* 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-01 16:40:42 +02:00
Brice Waegeneire
c316b85692
doc: Replace section 'Early OOM service' by 'Linux Services'.
* 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-01 16:40:41 +02:00
Florian Pelz
e06664da02
system: Blacklist usbmouse kernel module in default kernel-arguments.
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-05-01 08:46:59 +00:00
Leo Famulari
6c7a39c45e
doc: Bootloader Configuration: Fix an obsolete example.
Reported by rawmat on #guix.

* doc/guix.texi (Bootloader Configuration): Replace 'grub-configuration' with
'bootloader-configuration'.
2020-04-30 17:22:01 -04:00
Marcin Karpezo
145df67b25
doc: cookbook: Rename stumpwm package to current state.
* doc/guix-cookbook.texi (StumpWM): Rename STUMPWM package to current state.

Signed-off-by: Oleg Pykhalov <go.wigust@gmail.com>
2020-04-30 00:43:46 +03:00
Diego Nicola Barbato
e4aa9ab637
doc: Mention that PulseAudio service overrides user configuration.
* 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-28 23:28:17 +02:00
operator.name
619f9181a3
doc: Update url to singularity before link rot occurs.
* doc/guix.texi: Update url to singularity before link rot occurs.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-04-27 23:29:40 +02:00
TomZ
f4f4aa628a
doc: guix: Fix grammar in "Debugging Build Failures"
* doc/guix.texi (Debugging Build Failures): Fix grammar.

Signed-off-by: Jakub Kądziołka <kuba@kadziolka.net>
2020-04-27 18:24:19 +02:00
Nicolas Goaziou
d558de8048
doc: guix: Fix some markup.
* 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-25 23:35:44 +02:00
Nicolas Goaziou
128b136ec6
doc: cookbook: Fix quotes.
* doc/guix-cookbook.texi (Basic setup with manifests):
(Default profile):
(The benefits of manifests): Use proper quotes in regular texts.
2020-04-25 23:10:16 +02:00
Nicolas Goaziou
2c8305d140
doc: cookbook: Use @file for file names and extensions.
* 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-24 18:40:04 +02:00
Nicolas Goaziou
cc765e478a
doc: cookbook: Fix misuses of double spacing.
* 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-24 18:32:56 +02:00
Marius Bakke
7dd05396ef
doc: Ensure guix-daemon is built before creating guix-daemon.1.
* doc/local.mk ($(srcdir)/%D%/guix-daemon.1): Depend on guix-daemon$(EXEEXT)
instead of its source code.
2020-04-24 16:24:01 +02:00
Ludovic Courtès
62bc3c5b04
build: Don't build man pages when cross-compiling.
* configure.ac: Define 'CROSS_COMPILING' Automake conditional.
* doc/local.mk (dist_man1_MANS): Wrap in "if !CROSS_COMPILING".
2020-04-23 23:59:23 +02:00
Ludovic Courtès
d9e83f2a64
doc: Build more man pages.
* doc/local.mk (sub_commands_mans): Add guix-deploy.1,
guix-time-machine.1, and guix-weather.1.
2020-04-23 23:59:22 +02:00
Raghav Gururajan
5483a2d0a9
gnu: font-gnu-freefont: Add otf and woff font types.
* 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-22 17:59:44 -04:00
Matthew Brooks
60651dd962
doc: cookbook: Explain how to use bind mounts.
* doc/guix-cookbook.texi (Setting up a bind mount): Add example.

Signed-off-by: Leo Famulari <leo@famulari.name>
2020-04-22 15:49:53 -04:00
Ludovic Courtès
9475c631a7
doc: Adjust @var vs. @code.
* doc/guix.texi (Base Services): Adjust @var vs. @code.  Use 'cons'
instead of 'cons*' in example.
2020-04-22 19:23:58 +02:00
Brice Waegeneire
2b0c0d9301
services: Add udev-rules-service helper.
* 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-22 19:23:58 +02:00
Ludovic Courtès
34faf63ebc
gexp: Add 'load-path?' field to <scheme-file>.
* 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-22 19:23:57 +02:00
Ludovic Courtès
cb26edc8f6
doc: Include *.json files in the source.
This is a followup to c9f321e52a.

* doc/build.scm (texinfo-manual-source)[build]: Add *.json to #$output.
2020-04-21 23:52:19 +02:00
Ludovic Courtès
c8d8f6160e
packages: Recommend against the use of 'package-file'.
* guix/packages.scm (package-file): Recommend against its use in the
docstring.
* doc/guix.texi (The Store Monad): Likewise.
2020-04-21 00:06:40 +02:00
Ludovic Courtès
5e7076f2a5
services: Add 'simulated-wifi-service-type'.
* 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-19 23:50:17 +02:00
Ludovic Courtès
a03943ec00
services: Add 'hostapd-service-type'.
* 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-19 23:50:17 +02:00
Ludovic Courtès
40c6b1802c
doc: Make install script more prominent.
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-19 13:27:07 +02:00
mikadoZero
a37c59af62
doc: Update nar decompression examples.
* 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-17 23:18:32 +02:00
Ludovic Courtès
9d0b9c7c6c
maint: Provide the configuration file in the VM image.
This fixes a bug introduced in 362bcdb1b0
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-17 23:18:32 +02:00
Ludovic Courtès
08a70aa424
doc: Replace incorrect uses of @var with @code.
@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-17 13:03:01 +02:00
Ricardo Wurmus
c9f321e52a
doc: Document building and installing from JSON files.
* 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-16 23:41:52 +02:00
R Veera Kumar
cc36b7c855
doc: Add dicod-service-type in Dictionary Services.
* doc/guix.texi (Miscellaneous Services): Add dicod-service-type
in Dictionary Services.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2020-04-16 18:33:21 +02:00
Ludovic Courtès
33f3fef383
doc: Remove bogus index entry.
* doc/guix.texi (Build Systems): Remove bogus and redundant entry for
'copy-build-system'.
2020-04-16 18:33:21 +02:00
Nicolas Goaziou
b44e19acd1
doc: Fix typo.
* doc/guix.texi (Running Guix in a VM): Add missing reference to
`spice-vdagent-service' and misuse of @pxref.
2020-04-15 19:11:32 +02:00
Brice Waegeneire
1373cb4080
doc: Fix typo.
* 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-14 19:21:12 +01:00
Ludovic Courtès
deac7bf6ac
doc: Improve anchor collection.
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-13 12:28:41 +02:00
Ludovic Courtès
c2480d1042
doc: Avoid invalid 'match' pattern in 'syntax-highlighted-html'.
This is a followup to da9deba13d.

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-13 02:12:08 +02:00
Ludovic Courtès
da9deba13d
doc: Emit hyperlinks in HTML output for @lisp snippets.
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-13 01:21:49 +02:00
Ludovic Courtès
8c04471f24
doc: Mention HTTP/HTTPS proxy in the system installation instructions.
* doc/guix.texi (Keyboard Layout and Networking and Partitioning):
Mention 'herd set-http-proxy guix-daemon'.
2020-04-08 12:42:41 +02:00
Ludovic Courtès
3302e03ba0
services: guix: Add 'set-http-proxy' action.
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-07 12:31:36 +02:00
Ludovic Courtès
0468455e7d
services: Add 'rottlog-service-type' to '%base-services'.
* 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-06 12:07:49 +02:00
Ludovic Courtès
d636e54c27
doc: Make 'fc-cache -rv' instructions more prominent.
* doc/guix.texi (Application Setup): Move the "fc-cache" instructions
next to the Fontconfig paragraph and make the command more visible.
2020-04-06 12:07:49 +02:00