mirror of
https://git.savannah.gnu.org/git/guix.git
synced 2026-07-08 18:04:04 +02:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 48aa30ce73 | |||
| adf577dcc4 | |||
| 1a9fc8e228 | |||
| 2921b6a611 | |||
| 3aa11dfbed | |||
| 542e7fb57f |
@@ -536,6 +536,7 @@ EXTRA_DIST += \
|
|||||||
tests/cve-sample.xml \
|
tests/cve-sample.xml \
|
||||||
build-aux/config.rpath \
|
build-aux/config.rpath \
|
||||||
bootstrap \
|
bootstrap \
|
||||||
|
doc/build.scm \
|
||||||
release.nix \
|
release.nix \
|
||||||
$(TESTS)
|
$(TESTS)
|
||||||
|
|
||||||
|
|||||||
+563
@@ -0,0 +1,563 @@
|
|||||||
|
;;; GNU Guix --- Functional package management for GNU
|
||||||
|
;;; Copyright © 2019 Ludovic Courtès <ludo@gnu.org>
|
||||||
|
;;;
|
||||||
|
;;; This file is part of GNU Guix.
|
||||||
|
;;;
|
||||||
|
;;; GNU Guix is free software; you can redistribute it and/or modify it
|
||||||
|
;;; under the terms of the GNU General Public License as published by
|
||||||
|
;;; the Free Software Foundation; either version 3 of the License, or (at
|
||||||
|
;;; your option) any later version.
|
||||||
|
;;;
|
||||||
|
;;; GNU Guix is distributed in the hope that it will be useful, but
|
||||||
|
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
;;; GNU General Public License for more details.
|
||||||
|
;;;
|
||||||
|
;;; You should have received a copy of the GNU General Public License
|
||||||
|
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
|
||||||
|
;; This file contains machinery to build HTML and PDF copies of the manual
|
||||||
|
;; that can be readily published on the web site. To do that, run:
|
||||||
|
;;
|
||||||
|
;; guix build -f build.scm
|
||||||
|
;;
|
||||||
|
;; The result is a directory hierarchy that can be used as the manual/
|
||||||
|
;; sub-directory of the web site.
|
||||||
|
|
||||||
|
(use-modules (guix)
|
||||||
|
(guix gexp)
|
||||||
|
(guix git)
|
||||||
|
(guix git-download)
|
||||||
|
(git)
|
||||||
|
(gnu packages base)
|
||||||
|
(gnu packages gawk)
|
||||||
|
(gnu packages gettext)
|
||||||
|
(gnu packages guile)
|
||||||
|
(gnu packages texinfo)
|
||||||
|
(gnu packages tex)
|
||||||
|
(srfi srfi-19)
|
||||||
|
(srfi srfi-71))
|
||||||
|
|
||||||
|
(define file-append*
|
||||||
|
(@@ (guix self) file-append*))
|
||||||
|
|
||||||
|
(define translated-texi-manuals
|
||||||
|
(@@ (guix self) translate-texi-manuals))
|
||||||
|
|
||||||
|
(define info-manual
|
||||||
|
(@@ (guix self) info-manual))
|
||||||
|
|
||||||
|
(define %languages
|
||||||
|
'("de" "en" "es" "fr" "ru" "zh_CN"))
|
||||||
|
|
||||||
|
(define (texinfo-manual-images source)
|
||||||
|
"Return a directory containing all the images used by the user manual, taken
|
||||||
|
from SOURCE, the root of the source tree."
|
||||||
|
(define graphviz
|
||||||
|
(module-ref (resolve-interface '(gnu packages graphviz))
|
||||||
|
'graphviz))
|
||||||
|
|
||||||
|
(define images
|
||||||
|
(file-append* source "doc/images"))
|
||||||
|
|
||||||
|
(define build
|
||||||
|
(with-imported-modules '((guix build utils))
|
||||||
|
#~(begin
|
||||||
|
(use-modules (guix build utils)
|
||||||
|
(srfi srfi-26))
|
||||||
|
|
||||||
|
(define (dot->image dot-file format)
|
||||||
|
(invoke #+(file-append graphviz "/bin/dot")
|
||||||
|
"-T" format "-Gratio=.9" "-Gnodesep=.005"
|
||||||
|
"-Granksep=.00005" "-Nfontsize=9"
|
||||||
|
"-Nheight=.1" "-Nwidth=.1"
|
||||||
|
"-o" (string-append #$output "/"
|
||||||
|
(basename dot-file ".dot")
|
||||||
|
"." format)
|
||||||
|
dot-file))
|
||||||
|
|
||||||
|
;; Build graphs.
|
||||||
|
(mkdir-p #$output)
|
||||||
|
(for-each (lambda (dot-file)
|
||||||
|
(for-each (cut dot->image dot-file <>)
|
||||||
|
'("png" "pdf")))
|
||||||
|
(find-files #$images "\\.dot$"))
|
||||||
|
|
||||||
|
;; Copy other PNGs.
|
||||||
|
(for-each (lambda (png-file)
|
||||||
|
(install-file png-file #$output))
|
||||||
|
(find-files #$images "\\.png$")))))
|
||||||
|
|
||||||
|
(computed-file "texinfo-manual-images" build))
|
||||||
|
|
||||||
|
(define* (texinfo-manual-source source #:key
|
||||||
|
(version "0.0")
|
||||||
|
(languages %languages)
|
||||||
|
(date 1))
|
||||||
|
"Gather all the source files of the Texinfo manuals from SOURCE--.texi file
|
||||||
|
as well as images, OS examples, and translations."
|
||||||
|
(define documentation
|
||||||
|
(file-append* source "doc"))
|
||||||
|
|
||||||
|
(define examples
|
||||||
|
(file-append* source "gnu/system/examples"))
|
||||||
|
|
||||||
|
(define build
|
||||||
|
(with-imported-modules '((guix build utils))
|
||||||
|
#~(begin
|
||||||
|
(use-modules (guix build utils)
|
||||||
|
(srfi srfi-19))
|
||||||
|
|
||||||
|
(define (make-version-texi language)
|
||||||
|
;; Create the 'version.texi' file for LANGUAGE.
|
||||||
|
(let ((file (if (string=? language "en")
|
||||||
|
"version.texi"
|
||||||
|
(string-append "version-" language ".texi"))))
|
||||||
|
(call-with-output-file (string-append #$output "/" file)
|
||||||
|
(lambda (port)
|
||||||
|
(let* ((version #$version)
|
||||||
|
(time (make-time time-utc 0 #$date))
|
||||||
|
(date (time-utc->date time)))
|
||||||
|
(format port "
|
||||||
|
@set UPDATED ~a
|
||||||
|
@set UPDATED-MONTH ~a
|
||||||
|
@set EDITION ~a
|
||||||
|
@set VERSION ~a\n"
|
||||||
|
(date->string date "~e ~B ~Y")
|
||||||
|
(date->string date "~B ~Y")
|
||||||
|
version version))))))
|
||||||
|
|
||||||
|
(install-file #$(file-append* documentation "/htmlxref.cnf")
|
||||||
|
#$output)
|
||||||
|
|
||||||
|
(for-each (lambda (texi)
|
||||||
|
(install-file texi #$output))
|
||||||
|
(append (find-files #$documentation "\\.(texi|scm)$")
|
||||||
|
(find-files #$(translated-texi-manuals source)
|
||||||
|
"\\.texi$")))
|
||||||
|
|
||||||
|
;; Create 'version.texi'.
|
||||||
|
(for-each make-version-texi '#$languages)
|
||||||
|
|
||||||
|
;; Copy configuration templates that the manual includes.
|
||||||
|
(for-each (lambda (template)
|
||||||
|
(copy-file template
|
||||||
|
(string-append
|
||||||
|
#$output "/os-config-"
|
||||||
|
(basename template ".tmpl")
|
||||||
|
".texi")))
|
||||||
|
(find-files #$examples "\\.tmpl$"))
|
||||||
|
|
||||||
|
(symlink #$(texinfo-manual-images source)
|
||||||
|
(string-append #$output "/images")))))
|
||||||
|
|
||||||
|
(computed-file "texinfo-manual-source" build))
|
||||||
|
|
||||||
|
(define %web-site-url
|
||||||
|
;; URL of the web site home page.
|
||||||
|
(or (getenv "GUIX_WEB_SITE_URL")
|
||||||
|
"/software/guix/"))
|
||||||
|
|
||||||
|
(define %makeinfo-html-options
|
||||||
|
;; Options passed to 'makeinfo --html'.
|
||||||
|
'("--css-ref=https://www.gnu.org/software/gnulib/manual.css"))
|
||||||
|
|
||||||
|
(define* (html-manual source #:key (languages %languages)
|
||||||
|
(version "0.0")
|
||||||
|
(manual "guix")
|
||||||
|
(date 1)
|
||||||
|
(options %makeinfo-html-options))
|
||||||
|
"Return the HTML manuals built from SOURCE for all LANGUAGES, with the given
|
||||||
|
makeinfo OPTIONS."
|
||||||
|
(define manual-source
|
||||||
|
(texinfo-manual-source source
|
||||||
|
#:version version
|
||||||
|
#:languages languages
|
||||||
|
#:date date))
|
||||||
|
|
||||||
|
(define build
|
||||||
|
(with-imported-modules '((guix build utils))
|
||||||
|
#~(begin
|
||||||
|
(use-modules (guix build utils)
|
||||||
|
(ice-9 match))
|
||||||
|
|
||||||
|
(define (normalize language)
|
||||||
|
;; Normalize LANGUAGE. For instance, "zh_CN" become "zh-cn".
|
||||||
|
(string-map (match-lambda
|
||||||
|
(#\_ #\-)
|
||||||
|
(chr chr))
|
||||||
|
(string-downcase language)))
|
||||||
|
|
||||||
|
;; Install a UTF-8 locale so that 'makeinfo' is at ease.
|
||||||
|
(setenv "GUIX_LOCPATH"
|
||||||
|
#+(file-append glibc-utf8-locales "/lib/locale"))
|
||||||
|
(setenv "LC_ALL" "en_US.utf8")
|
||||||
|
|
||||||
|
(setvbuf (current-output-port) 'line)
|
||||||
|
(setvbuf (current-error-port) 'line)
|
||||||
|
|
||||||
|
(for-each (lambda (language)
|
||||||
|
(let ((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")))))
|
||||||
|
(format #t "building HTML manual for language '~a'...~%"
|
||||||
|
language)
|
||||||
|
(mkdir-p (string-append #$output "/"
|
||||||
|
(normalize language)))
|
||||||
|
(setenv "LANGUAGE" language)
|
||||||
|
(apply invoke #$(file-append texinfo "/bin/makeinfo")
|
||||||
|
"-o" (string-append #$output "/"
|
||||||
|
(normalize language)
|
||||||
|
"/html_node")
|
||||||
|
opts)
|
||||||
|
(apply invoke #$(file-append texinfo "/bin/makeinfo")
|
||||||
|
"--no-split"
|
||||||
|
"-o"
|
||||||
|
(string-append #$output "/"
|
||||||
|
(normalize language)
|
||||||
|
"/" #$manual
|
||||||
|
(if (string=? language "en")
|
||||||
|
""
|
||||||
|
(string-append "." language))
|
||||||
|
".html")
|
||||||
|
opts)))
|
||||||
|
'#$languages))))
|
||||||
|
|
||||||
|
(computed-file (string-append manual "-html-manual") build))
|
||||||
|
|
||||||
|
(define* (pdf-manual source #:key (languages %languages)
|
||||||
|
(version "0.0")
|
||||||
|
(manual "guix")
|
||||||
|
(date 1)
|
||||||
|
(options '()))
|
||||||
|
"Return the HTML manuals built from SOURCE for all LANGUAGES, with the given
|
||||||
|
makeinfo OPTIONS."
|
||||||
|
(define manual-source
|
||||||
|
(texinfo-manual-source source
|
||||||
|
#:version version
|
||||||
|
#:languages languages
|
||||||
|
#:date date))
|
||||||
|
|
||||||
|
;; FIXME: This union works, except for the table of contents of non-English
|
||||||
|
;; manuals, which contains escape sequences like "^^ca^^fe" instead of
|
||||||
|
;; accented letters.
|
||||||
|
;;
|
||||||
|
;; (define texlive
|
||||||
|
;; (texlive-union (list texlive-tex-texinfo
|
||||||
|
;; texlive-generic-epsf
|
||||||
|
;; texlive-fonts-ec)))
|
||||||
|
|
||||||
|
(define build
|
||||||
|
(with-imported-modules '((guix build utils))
|
||||||
|
#~(begin
|
||||||
|
(use-modules (guix build utils)
|
||||||
|
(srfi srfi-34)
|
||||||
|
(ice-9 match))
|
||||||
|
|
||||||
|
(define (normalize language) ;XXX: deduplicate
|
||||||
|
;; Normalize LANGUAGE. For instance, "zh_CN" becomes "zh-cn".
|
||||||
|
(string-map (match-lambda
|
||||||
|
(#\_ #\-)
|
||||||
|
(chr chr))
|
||||||
|
(string-downcase language)))
|
||||||
|
|
||||||
|
;; Install a UTF-8 locale so that 'makeinfo' is at ease.
|
||||||
|
(setenv "GUIX_LOCPATH"
|
||||||
|
#+(file-append glibc-utf8-locales "/lib/locale"))
|
||||||
|
(setenv "LC_ALL" "en_US.utf8")
|
||||||
|
(setenv "PATH"
|
||||||
|
(string-append #+(file-append texlive "/bin") ":"
|
||||||
|
#+(file-append texinfo "/bin") ":"
|
||||||
|
|
||||||
|
;; Below are command-line tools needed by
|
||||||
|
;; 'texi2dvi' and friends.
|
||||||
|
#+(file-append sed "/bin") ":"
|
||||||
|
#+(file-append grep "/bin") ":"
|
||||||
|
#+(file-append coreutils "/bin") ":"
|
||||||
|
#+(file-append gawk "/bin") ":"
|
||||||
|
#+(file-append tar "/bin") ":"
|
||||||
|
#+(file-append diffutils "/bin")))
|
||||||
|
|
||||||
|
(setvbuf (current-output-port) 'line)
|
||||||
|
(setvbuf (current-error-port) 'line)
|
||||||
|
|
||||||
|
(setenv "HOME" (getcwd)) ;for kpathsea/mktextfm
|
||||||
|
|
||||||
|
;; 'SOURCE_DATE_EPOCH' is honored by pdftex.
|
||||||
|
(setenv "SOURCE_DATE_EPOCH" "1")
|
||||||
|
|
||||||
|
(for-each (lambda (language)
|
||||||
|
(let ((opts `("--pdf"
|
||||||
|
"-I" "."
|
||||||
|
#$@options
|
||||||
|
,(if (string=? language "en")
|
||||||
|
(string-append #$manual-source "/"
|
||||||
|
#$manual ".texi")
|
||||||
|
(string-append #$manual-source "/"
|
||||||
|
#$manual "." language ".texi")))))
|
||||||
|
(format #t "building PDF manual for language '~a'...~%"
|
||||||
|
language)
|
||||||
|
(mkdir-p (string-append #$output "/"
|
||||||
|
(normalize language)))
|
||||||
|
(setenv "LANGUAGE" language)
|
||||||
|
|
||||||
|
|
||||||
|
;; FIXME: Unfortunately building PDFs for non-Latin
|
||||||
|
;; alphabets doesn't work:
|
||||||
|
;; <https://lists.gnu.org/archive/html/help-texinfo/2012-01/msg00014.html>.
|
||||||
|
(guard (c ((invoke-error? c)
|
||||||
|
(format (current-error-port)
|
||||||
|
"~%~%Failed to produce \
|
||||||
|
PDF for language '~a'!~%~%"
|
||||||
|
language)))
|
||||||
|
(apply invoke #$(file-append texinfo "/bin/makeinfo")
|
||||||
|
"--pdf" "-o"
|
||||||
|
(string-append #$output "/"
|
||||||
|
(normalize language)
|
||||||
|
"/" #$manual
|
||||||
|
(if (string=? language "en")
|
||||||
|
""
|
||||||
|
(string-append "."
|
||||||
|
language))
|
||||||
|
".pdf")
|
||||||
|
opts))))
|
||||||
|
'#$languages))))
|
||||||
|
|
||||||
|
(computed-file (string-append manual "-pdf-manual") build))
|
||||||
|
|
||||||
|
(define (guix-manual-text-domain source languages)
|
||||||
|
"Return the PO files for LANGUAGES of the 'guix-manual' text domain taken
|
||||||
|
from SOURCE."
|
||||||
|
(define po-directory
|
||||||
|
(file-append* source "/po/doc"))
|
||||||
|
|
||||||
|
(define build
|
||||||
|
(with-imported-modules '((guix build utils))
|
||||||
|
#~(begin
|
||||||
|
(use-modules (guix build utils))
|
||||||
|
|
||||||
|
(mkdir-p #$output)
|
||||||
|
(for-each (lambda (language)
|
||||||
|
(define directory
|
||||||
|
(string-append #$output "/" language
|
||||||
|
"/LC_MESSAGES"))
|
||||||
|
|
||||||
|
(mkdir-p directory)
|
||||||
|
(invoke #+(file-append gnu-gettext "/bin/msgfmt")
|
||||||
|
"-c" "-o"
|
||||||
|
(string-append directory "/guix-manual.mo")
|
||||||
|
(string-append #$po-directory "/guix-manual."
|
||||||
|
language ".po")))
|
||||||
|
'#$(delete "en" languages)))))
|
||||||
|
|
||||||
|
(computed-file "guix-manual-po" build))
|
||||||
|
|
||||||
|
(define* (html-manual-indexes source
|
||||||
|
#:key (languages %languages)
|
||||||
|
(version "0.0")
|
||||||
|
(manual "guix")
|
||||||
|
(date 1))
|
||||||
|
(define build
|
||||||
|
(with-imported-modules '((guix build utils))
|
||||||
|
#~(begin
|
||||||
|
(use-modules (guix build utils)
|
||||||
|
(ice-9 match)
|
||||||
|
(ice-9 popen)
|
||||||
|
(sxml simple)
|
||||||
|
(srfi srfi-19))
|
||||||
|
|
||||||
|
(define (normalize language) ;XXX: deduplicate
|
||||||
|
;; Normalize LANGUAGE. For instance, "zh_CN" become "zh-cn".
|
||||||
|
(string-map (match-lambda
|
||||||
|
(#\_ #\-)
|
||||||
|
(chr chr))
|
||||||
|
(string-downcase language)))
|
||||||
|
|
||||||
|
(define-syntax-rule (with-language language exp ...)
|
||||||
|
(let ((lang (getenv "LANGUAGE")))
|
||||||
|
(dynamic-wind
|
||||||
|
(lambda ()
|
||||||
|
(setenv "LANGUAGE" language)
|
||||||
|
(setlocale LC_MESSAGES))
|
||||||
|
(lambda () exp ...)
|
||||||
|
(lambda ()
|
||||||
|
(if lang
|
||||||
|
(setenv "LANGUAGE" lang)
|
||||||
|
(unsetenv "LANGUAGE"))
|
||||||
|
(setlocale LC_MESSAGES)))))
|
||||||
|
|
||||||
|
;; (put 'with-language 'scheme-indent-function 1)
|
||||||
|
(define* (translate str language
|
||||||
|
#:key (domain "guix-manual"))
|
||||||
|
(define exp
|
||||||
|
`(begin
|
||||||
|
(bindtextdomain "guix-manual"
|
||||||
|
#+(guix-manual-text-domain
|
||||||
|
source
|
||||||
|
languages))
|
||||||
|
(write (gettext ,str "guix-manual"))))
|
||||||
|
|
||||||
|
(with-language language
|
||||||
|
;; Since the 'gettext' function caches msgid translations,
|
||||||
|
;; regardless of $LANGUAGE, we have to spawn a new process each
|
||||||
|
;; time we want to translate to a different language. Bah!
|
||||||
|
(let* ((pipe (open-pipe* OPEN_READ
|
||||||
|
#+(file-append guile-2.2
|
||||||
|
"/bin/guile")
|
||||||
|
"-c" (object->string exp)))
|
||||||
|
(str (read pipe)))
|
||||||
|
(close-pipe pipe)
|
||||||
|
str)))
|
||||||
|
|
||||||
|
(define (seconds->string seconds language)
|
||||||
|
(let* ((time (make-time time-utc 0 seconds))
|
||||||
|
(date (time-utc->date time)))
|
||||||
|
(with-language language (date->string date "~e ~B ~Y"))))
|
||||||
|
|
||||||
|
(define (guix-url path)
|
||||||
|
(string-append #$%web-site-url path))
|
||||||
|
|
||||||
|
(define (sxml-index language)
|
||||||
|
(define title
|
||||||
|
(translate "GNU Guix Reference Manual" language))
|
||||||
|
|
||||||
|
;; FIXME: Avoid duplicating styling info from guix-artwork.git.
|
||||||
|
`(html (@ (lang ,language))
|
||||||
|
(head
|
||||||
|
(title ,(string-append title " — GNU Guix"))
|
||||||
|
(meta (@ (charset "UTF-8")))
|
||||||
|
(meta (@ (name "viewport") (content "width=device-width, initial-scale=1.0")))
|
||||||
|
;; Menu prefetch.
|
||||||
|
(link (@ (rel "prefetch") (href ,(guix-url "menu/index.html"))))
|
||||||
|
;; Base CSS.
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/elements.css"))))
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/common.css"))))
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/messages.css"))))
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/navbar.css"))))
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/breadcrumbs.css"))))
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/buttons.css"))))
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/footer.css"))))
|
||||||
|
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/page.css"))))
|
||||||
|
(link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/post.css")))))
|
||||||
|
(body
|
||||||
|
(header (@ (class "navbar"))
|
||||||
|
(h1 (a (@ (class "branding")
|
||||||
|
(href #$%web-site-url)))
|
||||||
|
(span (@ (class "a11y-offset"))
|
||||||
|
"Guix"))
|
||||||
|
(nav (@ (class "menu"))))
|
||||||
|
(nav (@ (class "breadcrumbs"))
|
||||||
|
(a (@ (class "crumb")
|
||||||
|
(href #$%web-site-url))
|
||||||
|
"Home"))
|
||||||
|
(main
|
||||||
|
(article
|
||||||
|
(@ (class "page centered-block limit-width"))
|
||||||
|
(h2 ,title)
|
||||||
|
(p (@ (class "post-metadata centered-text"))
|
||||||
|
#$version " — "
|
||||||
|
,(seconds->string #$date language))
|
||||||
|
|
||||||
|
(div
|
||||||
|
(ul
|
||||||
|
(li (a (@ (href "html_node"))
|
||||||
|
"HTML, with one page per node"))
|
||||||
|
(li (a (@ (href
|
||||||
|
,(string-append
|
||||||
|
#$manual
|
||||||
|
(if (string=? language
|
||||||
|
"en")
|
||||||
|
""
|
||||||
|
(string-append "."
|
||||||
|
language))
|
||||||
|
".html")))
|
||||||
|
"HTML, entirely on one page"))
|
||||||
|
,@(if (member language '("ru" "zh_CN"))
|
||||||
|
'()
|
||||||
|
`((li (a (@ (href ,(string-append
|
||||||
|
#$manual
|
||||||
|
(if (string=? language "en")
|
||||||
|
""
|
||||||
|
(string-append "."
|
||||||
|
language))
|
||||||
|
".pdf"))))
|
||||||
|
"PDF")))))))
|
||||||
|
(footer))))
|
||||||
|
|
||||||
|
(define (write-index language file)
|
||||||
|
(call-with-output-file file
|
||||||
|
(lambda (port)
|
||||||
|
(display "<!DOCTYPE html>\n" port)
|
||||||
|
(sxml->xml (sxml-index language) port))))
|
||||||
|
|
||||||
|
(setenv "GUIX_LOCPATH"
|
||||||
|
#+(file-append glibc-utf8-locales "/lib/locale"))
|
||||||
|
(setenv "LC_ALL" "en_US.utf8")
|
||||||
|
(setlocale LC_ALL "en_US.utf8")
|
||||||
|
|
||||||
|
(bindtextdomain "guix-manual"
|
||||||
|
#+(guix-manual-text-domain source languages))
|
||||||
|
|
||||||
|
(for-each (lambda (language)
|
||||||
|
(define directory
|
||||||
|
(string-append #$output "/"
|
||||||
|
(normalize language)))
|
||||||
|
|
||||||
|
(mkdir-p directory)
|
||||||
|
(write-index language
|
||||||
|
(string-append directory
|
||||||
|
"/index.html")))
|
||||||
|
'#$languages))))
|
||||||
|
|
||||||
|
(computed-file "html-indexes" build))
|
||||||
|
|
||||||
|
(define* (pdf+html-manual source
|
||||||
|
#:key (languages %languages)
|
||||||
|
(version "0.0")
|
||||||
|
(date (time-second (current-time time-utc)))
|
||||||
|
(manual "guix"))
|
||||||
|
"Return the union of the HTML and PDF manuals, as well as the indexes."
|
||||||
|
(directory-union (string-append manual "-manual")
|
||||||
|
(map (lambda (proc)
|
||||||
|
(proc source
|
||||||
|
#:date date
|
||||||
|
#:languages languages
|
||||||
|
#:version version
|
||||||
|
#:manual manual))
|
||||||
|
(list html-manual-indexes
|
||||||
|
html-manual pdf-manual))
|
||||||
|
#:copy? #t))
|
||||||
|
|
||||||
|
(define (latest-commit+date directory)
|
||||||
|
"Return two values: the last commit ID (a hex string) for DIRECTORY, and its
|
||||||
|
commit date (an integer)."
|
||||||
|
(let* ((repository (repository-open directory))
|
||||||
|
(head (repository-head repository))
|
||||||
|
(oid (reference-target head))
|
||||||
|
(commit (commit-lookup repository oid)))
|
||||||
|
;; TODO: Use (git describe) when it's widely available.
|
||||||
|
(values (oid->string oid) (commit-time commit))))
|
||||||
|
|
||||||
|
|
||||||
|
(let* ((root (canonicalize-path
|
||||||
|
(string-append (current-source-directory) "/..")))
|
||||||
|
(commit date (latest-commit+date root)))
|
||||||
|
(format (current-error-port)
|
||||||
|
"building manual from work tree around commit ~a, ~a~%"
|
||||||
|
commit
|
||||||
|
(let* ((time (make-time time-utc 0 date))
|
||||||
|
(date (time-utc->date time)))
|
||||||
|
(date->string date "~e ~B ~Y")))
|
||||||
|
(pdf+html-manual (local-file root "guix" #:recursive? #t
|
||||||
|
#:select? (git-predicate root))
|
||||||
|
#:version (or (getenv "GUIX_MANUAL_VERSION")
|
||||||
|
(string-take commit 7))
|
||||||
|
#:date date))
|
||||||
+59
-4
@@ -1774,6 +1774,11 @@ on a machine. Guix, as a package manager, can
|
|||||||
also be installed on top of a running GNU/Linux system,
|
also be installed on top of a running GNU/Linux system,
|
||||||
@pxref{Installation}.
|
@pxref{Installation}.
|
||||||
|
|
||||||
|
@quotation Important Note
|
||||||
|
@xref{Guided Graphical Installation}, on how to work around a bug that affects
|
||||||
|
the graphical installer in version 1.0.0.
|
||||||
|
@end quotation
|
||||||
|
|
||||||
@ifinfo
|
@ifinfo
|
||||||
@quotation Note
|
@quotation Note
|
||||||
@c This paragraph is for people reading this from tty2 of the
|
@c This paragraph is for people reading this from tty2 of the
|
||||||
@@ -1992,6 +1997,57 @@ dependencies of your system configuration can be downloaded. See the
|
|||||||
The graphical installer is a text-based user interface. It will guide you,
|
The graphical installer is a text-based user interface. It will guide you,
|
||||||
with dialog boxes, through the steps needed to install GNU@tie{}Guix System.
|
with dialog boxes, through the steps needed to install GNU@tie{}Guix System.
|
||||||
|
|
||||||
|
@quotation Important Note
|
||||||
|
Due to a @uref{https://issues.guix.info/issue/35541, bug}, the graphical
|
||||||
|
installer of Guix 1.0.0 may produce a system configuration where essential
|
||||||
|
commands such as @command{ls} or @command{grep} are missing; as a side effect,
|
||||||
|
it also prevents logging in into Xfce. A new release will be published in the
|
||||||
|
coming weeks. Here is how you can work around it in the meantime on your
|
||||||
|
freshly installed system:
|
||||||
|
|
||||||
|
@itemize
|
||||||
|
@item
|
||||||
|
Install packages that provide those commands, along with the text editor of
|
||||||
|
your choice (for example, @code{emacs} or @code{vim}):
|
||||||
|
|
||||||
|
@example
|
||||||
|
guix install coreutils findutils grep procps sed emacs vim
|
||||||
|
@end example
|
||||||
|
|
||||||
|
At this point, the essential commands you would expect are available.
|
||||||
|
|
||||||
|
@item
|
||||||
|
Open your configuration file with your editor of choice, for example
|
||||||
|
@command{emacs}, running as root:
|
||||||
|
|
||||||
|
@example
|
||||||
|
sudo emacs /etc/config.scm
|
||||||
|
@end example
|
||||||
|
|
||||||
|
@item
|
||||||
|
Change the @code{packages} field to add the ``base packages'' to the list of
|
||||||
|
globally-installed packages, such that your configuration looks like this:
|
||||||
|
|
||||||
|
@lisp
|
||||||
|
(operating-system
|
||||||
|
;; ... snip ...
|
||||||
|
(packages (append (list (specification->package "nss-certs"))
|
||||||
|
%base-packages))
|
||||||
|
;; ... snip ...
|
||||||
|
)
|
||||||
|
@end lisp
|
||||||
|
|
||||||
|
@item
|
||||||
|
Reconfigure the system so that your new configuration is in effect:
|
||||||
|
|
||||||
|
@example
|
||||||
|
guix pull && sudo guix system reconfigure /etc/config.scm
|
||||||
|
@end example
|
||||||
|
@end itemize
|
||||||
|
|
||||||
|
We apologize for this embarrassing mistake.
|
||||||
|
@end quotation
|
||||||
|
|
||||||
The first dialog boxes allow you to set up the system as you use it during the
|
The first dialog boxes allow you to set up the system as you use it during the
|
||||||
installation: you can choose the language, keyboard layout, and set up
|
installation: you can choose the language, keyboard layout, and set up
|
||||||
networking, which will be used during the installation. The image below shows
|
networking, which will be used during the installation. The image below shows
|
||||||
@@ -5242,8 +5298,7 @@ Return the @code{<derivation>} object of @var{package} cross-built from
|
|||||||
|
|
||||||
@var{target} must be a valid GNU triplet denoting the target hardware
|
@var{target} must be a valid GNU triplet denoting the target hardware
|
||||||
and operating system, such as @code{"mips64el-linux-gnu"}
|
and operating system, such as @code{"mips64el-linux-gnu"}
|
||||||
(@pxref{Configuration Names, GNU configuration triplets,, configure, GNU
|
(@pxref{Specifying Target Triplets,,, autoconf, Autoconf}).
|
||||||
Configure and Build System}).
|
|
||||||
@end deffn
|
@end deffn
|
||||||
|
|
||||||
@cindex package transformations
|
@cindex package transformations
|
||||||
@@ -8100,7 +8155,7 @@ also be offloaded to a remote machine of the right architecture.
|
|||||||
@item --target=@var{triplet}
|
@item --target=@var{triplet}
|
||||||
@cindex cross-compilation
|
@cindex cross-compilation
|
||||||
Cross-build for @var{triplet}, which must be a valid GNU triplet, such
|
Cross-build for @var{triplet}, which must be a valid GNU triplet, such
|
||||||
as @code{"mips64el-linux-gnu"} (@pxref{Specifying target triplets, GNU
|
as @code{"mips64el-linux-gnu"} (@pxref{Specifying Target Triplets, GNU
|
||||||
configuration triplets,, autoconf, Autoconf}).
|
configuration triplets,, autoconf, Autoconf}).
|
||||||
|
|
||||||
@anchor{build-check}
|
@anchor{build-check}
|
||||||
@@ -24649,7 +24704,7 @@ example graph.
|
|||||||
@cindex virtual machine
|
@cindex virtual machine
|
||||||
To run Guix in a virtual machine (VM), one can use the pre-built Guix VM image
|
To run Guix in a virtual machine (VM), one can use the pre-built Guix VM image
|
||||||
distributed at
|
distributed at
|
||||||
@indicateurl{@value{BASE-URL}/guix-system-vm-image-@value{VERSION}.@var{system}.xz}
|
@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
|
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
|
decompress with @command{xz -d}, and then you can pass it to an emulator such
|
||||||
as QEMU (see below for details).
|
as QEMU (see below for details).
|
||||||
|
|||||||
+17
-5
@@ -1,9 +1,9 @@
|
|||||||
# htmlxref.cnf - reference file for free Texinfo manuals on the web.
|
# htmlxref.cnf - reference file for free Texinfo manuals on the web.
|
||||||
# Modified by Ludovic Courtès <ludo@gnu.org> for the GNU Guix manual.
|
# Modified by Ludovic Courtès <ludo@gnu.org> for the GNU Guix manual.
|
||||||
|
|
||||||
htmlxrefversion=2018-07-05.20; # UTC
|
htmlxrefversion=2019-05-04.20; # UTC
|
||||||
|
|
||||||
# Copyright 2010, 2011, 2012, 2013, 2014, 2015 Free Software Foundation, Inc.
|
# Copyright 2010, 2011, 2012, 2013, 2014, 2015, 2019 Free Software Foundation, Inc.
|
||||||
#
|
#
|
||||||
# Copying and distribution of this file, with or without modification,
|
# Copying and distribution of this file, with or without modification,
|
||||||
# are permitted in any medium without royalty provided the copyright
|
# are permitted in any medium without royalty provided the copyright
|
||||||
@@ -37,7 +37,7 @@ htmlxrefversion=2018-07-05.20; # UTC
|
|||||||
# associated, and thus gnu.org/manual can't include them.
|
# associated, and thus gnu.org/manual can't include them.
|
||||||
|
|
||||||
# shorten references to manuals on www.gnu.org.
|
# shorten references to manuals on www.gnu.org.
|
||||||
G = http://www.gnu.org
|
G = https://www.gnu.org
|
||||||
GS = ${G}/software
|
GS = ${G}/software
|
||||||
|
|
||||||
3dldf mono ${GS}/3dldf/manual/user_ref/3DLDF.html
|
3dldf mono ${GS}/3dldf/manual/user_ref/3DLDF.html
|
||||||
@@ -275,6 +275,10 @@ gdbm chapter ${GDBM}/html_chapter/
|
|||||||
gdbm section ${GDBM}/html_section/
|
gdbm section ${GDBM}/html_section/
|
||||||
gdbm node ${GDBM}/html_node/
|
gdbm node ${GDBM}/html_node/
|
||||||
|
|
||||||
|
# XXX: These are actually pages created by texi2html, so no quite following
|
||||||
|
# the expected naming scheme.
|
||||||
|
geiser chapter http://geiser.nongnu.org/
|
||||||
|
|
||||||
gettext mono ${GS}/gettext/manual/gettext.html
|
gettext mono ${GS}/gettext/manual/gettext.html
|
||||||
gettext node ${GS}/gettext/manual/html_node/
|
gettext node ${GS}/gettext/manual/html_node/
|
||||||
|
|
||||||
@@ -389,10 +393,14 @@ guile-gtk node ${GS}/guile-gtk/docs/guile-gtk/
|
|||||||
guile-rpc mono ${GS}/guile-rpc/manual/guile-rpc.html
|
guile-rpc mono ${GS}/guile-rpc/manual/guile-rpc.html
|
||||||
guile-rpc node ${GS}/guile-rpc/manual/html_node/
|
guile-rpc node ${GS}/guile-rpc/manual/html_node/
|
||||||
|
|
||||||
guix mono ${GS}/guix/manual/guix.html
|
guix.de mono ${GS}/guix/manual/de/guix.html
|
||||||
guix node ${GS}/guix/manual/html_node/
|
guix.de node ${GS}/guix/manual/de/html_node/
|
||||||
|
guix.es mono ${GS}/guix/manual/es/guix.html
|
||||||
|
guix.es node ${GS}/guix/manual/es/html_node/
|
||||||
guix.fr mono ${GS}/guix/manual/fr/guix.html
|
guix.fr mono ${GS}/guix/manual/fr/guix.html
|
||||||
guix.fr node ${GS}/guix/manual/fr/html_node/
|
guix.fr node ${GS}/guix/manual/fr/html_node/
|
||||||
|
guix mono ${GS}/guix/manual/en/guix.html
|
||||||
|
guix node ${GS}/guix/manual/en/html_node/
|
||||||
|
|
||||||
gv mono ${GS}/gv/manual/gv.html
|
gv mono ${GS}/gv/manual/gv.html
|
||||||
gv node ${GS}/gv/manual/html_node/
|
gv node ${GS}/gv/manual/html_node/
|
||||||
@@ -405,6 +413,10 @@ hello node ${GS}/hello/manual/html_node/
|
|||||||
|
|
||||||
help2man mono ${GS}/help2man/help2man.html
|
help2man mono ${GS}/help2man/help2man.html
|
||||||
|
|
||||||
|
# XXX: These are actually pages created by texi2html, so no quite following
|
||||||
|
# the expected naming scheme.
|
||||||
|
hurd mono ${GS}/hurd/doc/
|
||||||
|
|
||||||
idutils mono ${GS}/idutils/manual/idutils.html
|
idutils mono ${GS}/idutils/manual/idutils.html
|
||||||
idutils node ${GS}/idutils/manual/html_node/
|
idutils node ${GS}/idutils/manual/html_node/
|
||||||
|
|
||||||
|
|||||||
@@ -122,6 +122,10 @@ dist_infoimage_DATA = \
|
|||||||
%D%/images/installer-partitions.png \
|
%D%/images/installer-partitions.png \
|
||||||
%D%/images/installer-resume.png
|
%D%/images/installer-resume.png
|
||||||
|
|
||||||
|
# Ask for warnings about cross-referenced manuals that are not listed in
|
||||||
|
# htmlxref.cnf.
|
||||||
|
AM_MAKEINFOHTMLFLAGS = --set-customization-variable CHECK_HTMLXREF=true
|
||||||
|
|
||||||
# Try hard to obtain an image size and aspect that's reasonable for inclusion
|
# Try hard to obtain an image size and aspect that's reasonable for inclusion
|
||||||
# in an Info or PDF document.
|
# in an Info or PDF document.
|
||||||
DOT_OPTIONS = \
|
DOT_OPTIONS = \
|
||||||
|
|||||||
Reference in New Issue
Block a user