diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing.texi | 2 | ||||
| -rw-r--r-- | doc/guix.texi | 73 | ||||
| -rw-r--r-- | doc/local.mk | 43 |
3 files changed, 50 insertions, 68 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index ffa57e7cdf..f3e2aed55e 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -242,7 +242,7 @@ Manual}). First, you need more than an editor, you need wonderful @url{https://nongnu.org/geiser/, Geiser}. To set that up, run: @example -guix package -i emacs guile emacs-geiser +guix package -i emacs guile emacs-geiser emacs-geiser-guile @end example Geiser allows for interactive and incremental development from within diff --git a/doc/guix.texi b/doc/guix.texi index b6df0dcb64..9e5f808bfe 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -10,8 +10,8 @@ @include version.texi @c Identifier of the OpenPGP key used to sign tarballs and such. -@set OPENPGP-SIGNING-KEY-ID 3CE464558A84FDC69DB40CFB090B11993D9AEBB5 -@set OPENPGP-SIGNING-KEY-URL https://sv.gnu.org/people/viewgpg.php?user_id=15145 +@set OPENPGP-SIGNING-KEY-ID 27D586A4F8900854329FF09F1260E46482E63562 +@set OPENPGP-SIGNING-KEY-URL https://sv.gnu.org/people/viewgpg.php?user_id=127547 @c Base URL for downloads. @set BASE-URL https://ftp.gnu.org/gnu/guix @@ -2100,7 +2100,7 @@ about their support in GNU/Linux. An ISO-9660 installation image that can be written to a USB stick or burnt to a DVD can be downloaded from -@indicateurl{@value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.xz}, +@indicateurl{@value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso}, where you can replace @code{x86_64-linux} with one of: @table @code @@ -2116,8 +2116,8 @@ Make sure to download the associated @file{.sig} file and to verify the authenticity of the image against it, along these lines: @example -$ wget @value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.xz.sig -$ gpg --verify guix-system-install-@value{VERSION}.x86_64-linux.iso.xz.sig +$ wget @value{BASE-URL}/guix-system-install-@value{VERSION}.x86_64-linux.iso.sig +$ gpg --verify guix-system-install-@value{VERSION}.x86_64-linux.iso.sig @end example If that command fails because you do not have the required public key, @@ -2141,17 +2141,6 @@ It is meant to be copied @emph{as is} to a large-enough USB stick or DVD. @unnumberedsubsec Copying to a USB Stick -To copy the image to a USB stick, follow these steps: - -@enumerate -@item -Decompress the image using the @command{xz} command: - -@example -xz -d guix-system-install-@value{VERSION}.x86_64-linux.iso.xz -@end example - -@item Insert a USB stick of 1@tie{}GiB or more into your machine, and determine its device name. Assuming that the USB stick is known as @file{/dev/sdX}, copy the image with: @@ -2162,21 +2151,9 @@ sync @end example Access to @file{/dev/sdX} usually requires root privileges. -@end enumerate @unnumberedsubsec Burning on a DVD -To copy the image to a DVD, follow these steps: - -@enumerate -@item -Decompress the image using the @command{xz} command: - -@example -xz -d guix-system-install-@value{VERSION}.x86_64-linux.iso.xz -@end example - -@item Insert a blank DVD into your machine, and determine its device name. Assuming that the DVD drive is known as @file{/dev/srX}, copy the image with: @@ -2186,7 +2163,6 @@ growisofs -dvd-compat -Z /dev/srX=guix-system-install-@value{VERSION}.x86_64-lin @end example Access to @file{/dev/srX} usually requires root privileges. -@end enumerate @unnumberedsubsec Booting @@ -33666,12 +33642,11 @@ Whether or not the droplet should be created with IPv6 networking. @section Running Guix in a Virtual Machine @cindex virtual machine -To run Guix in a virtual machine (VM), one can use the pre-built Guix VM image -distributed at -@url{@value{BASE-URL}/guix-system-vm-image-@value{VERSION}.x86_64-linux.xz}. -This image is a compressed image in QCOW format. You will first need to -decompress with @command{xz -d}, and then you can pass it to an emulator such -as QEMU (see below for details). +To run Guix in a virtual machine (VM), one can use the pre-built Guix VM +image distributed at +@url{@value{BASE-URL}/guix-system-vm-image-@value{VERSION}.x86_64-linux.qcow2}. +This image is a compressed image in QCOW format. You can pass it to an +emulator such as @uref{https://qemu.org/, QEMU} (see below for details). This image boots the Xfce graphical environment and it contains some commonly used tools. You can install more software in the image by running @@ -33680,10 +33655,8 @@ also reconfigure the system based on its initial configuration file available as @file{/run/current-system/configuration.scm} (@pxref{Using the Configuration System}). -Instead of using this pre-built image, one can also build their own virtual -machine image using @command{guix system vm-image} (@pxref{Invoking guix -system}). The returned image is in qcow2 format, which the -@uref{https://qemu.org/, QEMU emulator} can efficiently use. +Instead of using this pre-built image, one can also build their own +image using @command{guix system image} (@pxref{Invoking guix system}). @cindex QEMU If you built your own image, you must copy it out of the store @@ -34290,6 +34263,28 @@ configuration when you use @command{guix system reconfigure}, @command{guix system init}, or @command{guix deploy}. @end defvr +@defvr {Scheme Variable} linux-loadable-module-service-type +Type of the service that collects lists of packages containing +kernel-loadable modules, and adds them to the set of kernel-loadable +modules. + +This service type is intended to be extended by other service types, +such as below: + +@lisp +(define module-installing-service-type + (service-type + (name 'module-installing-service) + (extensions (list (service-extension linux-loadable-module-service-type + (const (list module-to-install-1 + module-to-install-2))))) + (default-value #f))) +@end lisp + +This does not actually load modules at bootup, only adds it to the +kernel profile so that it @emph{can} be loaded by other means. +@end defvr + @node Shepherd Services @subsection Shepherd Services diff --git a/doc/local.mk b/doc/local.mk index d69a2feabd..34321d6656 100644 --- a/doc/local.mk +++ b/doc/local.mk @@ -4,7 +4,7 @@ # Copyright © 2013 Andreas Enge <andreas@enge.fr> # Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com> # Copyright © 2016, 2018 Mathieu Lirzin <mthl@gnu.org> -# Copyright © 2018 Julien Lepiller <julien@lepiller.eu> +# Copyright © 2018, 2021 Julien Lepiller <julien@lepiller.eu> # # This file is part of GNU Guix. # @@ -21,6 +21,16 @@ # You should have received a copy of the GNU General Public License # along with GNU Guix. If not, see <http://www.gnu.org/licenses/>. +# If adding a language, update the following variables, and info_TEXINFOS. +MANUAL_LANGUAGES = de es fa fr it ko pt_BR ru sk zh_CN +COOKBOOK_LANGUAGES = de fa fr ko zh_Hans + +# Arg1: A list of languages codes. +# Arg2: The file name stem. +lang_to_texinfo = $(foreach lang,$(1),%D%/$(2).$(lang).texi) + +# Automake does not understand GNU Make non-standard extensions, +# unfortunately, so we cannot use the above patsubst-based function here. info_TEXINFOS = %D%/guix.texi \ %D%/guix.de.texi \ %D%/guix.es.texi \ @@ -70,33 +80,10 @@ OS_CONFIG_EXAMPLES_TEXI = \ %D%/os-config-desktop.texi \ %D%/os-config-lightweight-desktop.texi -# Do not forget to update these, when updating info_TEXINFOS -TRANSLATED_INFO = \ - %D%/guix.de.texi \ - %D%/guix.es.texi \ - %D%/guix.fa.texi \ - %D%/guix.fr.texi \ - %D%/guix.it.texi \ - %D%/guix.ko.texi \ - %D%/guix.pt_BR.texi \ - %D%/guix.ru.texi \ - %D%/guix.sk.texi \ - %D%/guix.zh_CN.texi \ - %D%/contributing.de.texi \ - %D%/contributing.es.texi \ - %D%/contributing.fa.texi \ - %D%/contributing.fr.texi \ - %D%/contributing.it.texi \ - %D%/contributing.ko.texi \ - %D%/contributing.pt_BR.texi \ - %D%/contributing.ru.texi \ - %D%/contributing.sk.texi \ - %D%/contributing.zh_CN.texi \ - %D%/guix-cookbook.de.texi \ - %D%/guix-cookbook.fa.texi \ - %D%/guix-cookbook.fr.texi \ - %D%/guix-cookbook.ko.texi \ - %D%/guix-cookbook.zh_Hans.texi +TRANSLATED_INFO = \ + $(call lang_to_texinfo,$(MANUAL_LANGUAGES),guix) \ + $(call lang_to_texinfo,$(MANUAL_LANGUAGES),contributing) \ + $(call lang_to_texinfo,$(COOKBOOK_LANGUAGES),guix-cookbook) # Bundle this file so that makeinfo finds it in out-of-source-tree builds. BUILT_SOURCES += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO) |