summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarius Bakke <mbakke@fastmail.com>2019-10-23 20:48:55 +0200
committerMarius Bakke <mbakke@fastmail.com>2019-10-23 20:48:55 +0200
commit4c1918db34e09f0da793c607acc161bdf9ec5535 (patch)
treee84431dc161ed3c04c9b94abe8224ec7f759df5f /doc
parente8062974d5cc598134da4d57ff45970ac431611b (diff)
parent4163b6d855a4e655852029625762fccb077a196d (diff)
downloadpatches-4c1918db34e09f0da793c607acc161bdf9ec5535.tar
patches-4c1918db34e09f0da793c607acc161bdf9ec5535.tar.gz
Merge branch 'master' into staging
Diffstat (limited to 'doc')
-rw-r--r--doc/build.scm51
-rw-r--r--doc/guix.texi77
2 files changed, 96 insertions, 32 deletions
diff --git a/doc/build.scm b/doc/build.scm
index b6a921c421..81bb94670a 100644
--- a/doc/build.scm
+++ b/doc/build.scm
@@ -51,6 +51,12 @@
(define info-manual
(@@ (guix self) info-manual))
+(define %manual
+ ;; The manual to build--i.e., the base name of a .texi file, such as "guix"
+ ;; or "guix-cookbook".
+ (or (getenv "GUIX_MANUAL")
+ "guix"))
+
(define %languages
'("de" "en" "es" "fr" "ru" "zh_CN"))
@@ -164,7 +170,9 @@ as well as images, OS examples, and translations."
(define %makeinfo-html-options
;; Options passed to 'makeinfo --html'.
- '("--css-ref=https://www.gnu.org/software/gnulib/manual.css"))
+ '("--css-ref=https://www.gnu.org/software/gnulib/manual.css"
+ "-c" "EXTRA_HEAD=<meta name=\"viewport\" \
+content=\"width=device-width, initial-scale=1\" />"))
(define guile-lib/htmlprag-fixed
;; Guile-Lib with a hotfix for (htmlprag).
@@ -359,7 +367,7 @@ its <pre class=\"lisp\"> blocks (as produced by 'makeinfo --html')."
(define* (html-manual source #:key (languages %languages)
(version "0.0")
- (manual "guix")
+ (manual %manual)
(date 1)
(options %makeinfo-html-options))
"Return the HTML manuals built from SOURCE for all LANGUAGES, with the given
@@ -386,6 +394,13 @@ makeinfo OPTIONS."
(chr chr))
(string-downcase language)))
+ (define (language->texi-file-name language)
+ (if (string=? language "en")
+ (string-append #$manual-source "/"
+ #$manual ".texi")
+ (string-append #$manual-source "/"
+ #$manual "." language ".texi")))
+
;; Install a UTF-8 locale so that 'makeinfo' is at ease.
(setenv "GUIX_LOCPATH"
#+(file-append glibc-utf8-locales "/lib/locale"))
@@ -395,15 +410,12 @@ makeinfo OPTIONS."
(setvbuf (current-error-port) 'line)
(for-each (lambda (language)
- (let ((opts `("--html"
- "-c" ,(string-append "TOP_NODE_UP_URL=/manual/"
+ (let* ((texi (language->texi-file-name language))
+ (opts `("--html"
+ "-c" ,(string-append "TOP_NODE_UP_URL=/manual/"
language)
- #$@options
- ,(if (string=? language "en")
- (string-append #$manual-source "/"
- #$manual ".texi")
- (string-append #$manual-source "/"
- #$manual "." language ".texi")))))
+ #$@options
+ ,texi)))
(format #t "building HTML manual for language '~a'...~%"
language)
(mkdir-p (string-append #$output "/"
@@ -433,7 +445,8 @@ makeinfo OPTIONS."
(symlink #$images
(string-append #$output "/" (normalize language)
"/html_node/images"))))
- '#$languages))))
+ (filter (compose file-exists? language->texi-file-name)
+ '#$languages)))))
(let* ((name (string-append manual "-html-manual"))
(manual (computed-file name build)))
@@ -442,7 +455,7 @@ makeinfo OPTIONS."
(define* (pdf-manual source #:key (languages %languages)
(version "0.0")
- (manual "guix")
+ (manual %manual)
(date 1)
(options '()))
"Return the HTML manuals built from SOURCE for all LANGUAGES, with the given
@@ -570,7 +583,10 @@ from SOURCE."
(define* (html-manual-indexes source
#:key (languages %languages)
(version "0.0")
- (manual "guix")
+ (manual %manual)
+ (title (if (string=? "guix" manual)
+ "GNU Guix Reference Manual"
+ "GNU Guix Cookbook"))
(date 1))
(define build
(with-extensions (list guile-json-3)
@@ -674,7 +690,7 @@ from SOURCE."
(define (language-index language)
(define title
- (translate "GNU Guix Reference Manual" language))
+ (translate #$title language))
(sxml-index
language title
@@ -732,8 +748,7 @@ from SOURCE."
%iso639-languages)))
(define (top-level-index languages)
- (define title
- "GNU Guix Reference Manual")
+ (define title #$title)
(sxml-index
"en" title
`(main
@@ -741,7 +756,7 @@ from SOURCE."
(@ (class "page centered-block limit-width"))
(h2 ,title)
(div
- "The GNU Guix Reference Manual is available in the following
+ "This document is available in the following
languages:\n"
(ul
,@(map (lambda (language)
@@ -782,7 +797,7 @@ languages:\n"
#:key (languages %languages)
(version "0.0")
(date (time-second (current-time time-utc)))
- (manual "guix"))
+ (manual %manual))
"Return the union of the HTML and PDF manuals, as well as the indexes."
(directory-union (string-append manual "-manual")
(map (lambda (proc)
diff --git a/doc/guix.texi b/doc/guix.texi
index 6eccbb971f..746561ed97 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -9484,7 +9484,7 @@ that limit has been reset.
@cindex CVE, Common Vulnerabilities and Exposures
Report known vulnerabilities found in the Common Vulnerabilities and
Exposures (CVE) databases of the current and past year
-@uref{https://nvd.nist.gov/download.cfm#CVE_FEED, published by the US
+@uref{https://nvd.nist.gov/vuln/data-feeds, published by the US
NIST}.
To view information about a particular vulnerability, visit pages such as:
@@ -9501,7 +9501,7 @@ where @code{CVE-YYYY-ABCD} is the CVE identifier---e.g.,
@code{CVE-2015-7554}.
Package developers can specify in package recipes the
-@uref{https://nvd.nist.gov/cpe.cfm,Common Platform Enumeration (CPE)}
+@uref{https://nvd.nist.gov/products/cpe,Common Platform Enumeration (CPE)}
name and version of the package when they differ from the name or version
that Guix uses, as in this example:
@@ -14193,16 +14193,43 @@ Relogin after logout.
@cindex login manager
@cindex X11 login
-@deffn {Scheme Procedure} sddm-service config
-Return a service that spawns the SDDM graphical login manager for config of
-type @code{<sddm-configuration>}.
+@defvr {Scheme Variable} sddm-service-type
+This is the type of the service to run the
+@uref{https://github.com/sddm/sddm,SSDM display manager}. Its value
+must be a @code{sddm-configuration} record (see below).
-@example
- (sddm-service (sddm-configuration
- (auto-login-user "Alice")
- (auto-login-session "xfce.desktop")))
-@end example
-@end deffn
+Here's an example use:
+
+@lisp
+(service sddm-service-type
+ (sddm-configuration
+ (auto-login-user "alice")
+ (auto-login-session "xfce.desktop")))
+@end lisp
+@end defvr
+
+@deftp {Data Type} sddm-configuration
+This data type represents the configuration of the SDDM login manager.
+The available fields are:
+
+@table @asis
+@item @code{sddm} (default: @code{sddm})
+The SDDM package to use.
+
+@item @code{display-server} (default: @code{"x11"})
+This must be either @code{"x11"} or @code{"wayland"}.
+
+@c FIXME: Add more fields.
+
+@item @code{auto-login-user} (default: @code{""})
+If non-empty, this is the user account under which to log in
+automatically.
+
+@item @code{auto-login-session} (default: @code{""})
+If non-empty, this is the @file{.desktop} file name to use as the
+auto-login session.
+@end table
+@end deftp
@cindex Xorg, configuration
@deftp {Data Type} xorg-configuration
@@ -24546,6 +24573,10 @@ The type of device to connect to. Run @command{inputattach --help}, from the
@item @code{device} (default: @code{"/dev/ttyS0"})
The device file to connect to the device.
+@item @code{baud-rate} (default: @code{#f})
+Baud rate to use for the serial connection.
+Should be a number or @code{#f}.
+
@item @code{log-file} (default: @code{#f})
If true, this must be the name of a file to log messages to.
@end table
@@ -25973,12 +26004,10 @@ The object of the operating system configuration to deploy.
@item @code{environment}
An @code{environment-type} describing how the machine should be provisioned.
-At the moment, the only supported value is
-@code{managed-host-environment-type}.
@item @code{configuration} (default: @code{#f})
An object describing the configuration for the machine's @code{environment}.
-If the @code{environment} has a default configuration, @code{#f} maybe used.
+If the @code{environment} has a default configuration, @code{#f} may be used.
If @code{#f} is used for an environment with no default configuration,
however, an error will be thrown.
@end table
@@ -26006,6 +26035,26 @@ remote host.
@end table
@end deftp
+@deftp {Data Type} digital-ocean-configuration
+This is the data type describing the Droplet that should be created for a
+machine with an @code{environment} of @code{digital-ocean-environment-type}.
+
+@table @asis
+@item @code{ssh-key}
+The path to the SSH private key to use to authenticate with the remote
+host. In the future, this field may not exist.
+@item @code{tags}
+A list of string ``tags'' that uniquely identify the machine. Must be given
+such that no two machines in the deployment have the same set of tags.
+@item @code{region}
+A Digital Ocean region slug, such as @code{"nyc3"}.
+@item @code{size}
+A Digital Ocean size slug, such as @code{"s-1vcpu-1gb"}
+@item @code{enable-ipv6?}
+Whether or not the droplet should be created with IPv6 networking.
+@end table
+@end deftp
+
@node Running Guix in a VM
@section Running Guix in a Virtual Machine