Merge branch 'master' into core-updates
[jackhill/guix/guix.git] / doc / local.mk
1 # GNU Guix --- Functional package management for GNU
2 # Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
3 # Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès <ludo@gnu.org>
4 # Copyright © 2013 Andreas Enge <andreas@enge.fr>
5 # Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com>
6 # Copyright © 2016, 2018 Mathieu Lirzin <mthl@gnu.org>
7 # Copyright © 2018 Julien Lepiller <julien@lepiller.eu>
8 #
9 # This file is part of GNU Guix.
10 #
11 # GNU Guix is free software; you can redistribute it and/or modify it
12 # under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 3 of the License, or (at
14 # your option) any later version.
15 #
16 # GNU Guix is distributed in the hope that it will be useful, but
17 # WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
20 #
21 # You should have received a copy of the GNU General Public License
22 # along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
23
24 info_TEXINFOS = %D%/guix.texi \
25 %D%/guix.de.texi \
26 %D%/guix.es.texi \
27 %D%/guix.fr.texi \
28 %D%/guix.ru.texi \
29 %D%/guix.zh_CN.texi \
30 %D%/guix-cookbook.texi
31
32 %C%_guix_TEXINFOS = \
33 %D%/contributing.texi \
34 %D%/fdl-1.3.texi
35
36 DOT_FILES = \
37 %D%/images/bootstrap-graph.dot \
38 %D%/images/bootstrap-packages.dot \
39 %D%/images/coreutils-graph.dot \
40 %D%/images/coreutils-bag-graph.dot \
41 %D%/images/gcc-mesboot-bag-graph.dot \
42 %D%/images/service-graph.dot \
43 %D%/images/shepherd-graph.dot
44
45 DOT_VECTOR_GRAPHICS = \
46 $(DOT_FILES:%.dot=%.eps) \
47 $(DOT_FILES:%.dot=%.pdf)
48
49 EXTRA_DIST += \
50 %D%/htmlxref.cnf \
51 $(DOT_FILES) \
52 $(DOT_VECTOR_GRAPHICS) \
53 %D%/images/coreutils-size-map.eps \
54 %D%/environment-gdb.scm \
55 %D%/package-hello.scm
56
57 OS_CONFIG_EXAMPLES_TEXI = \
58 %D%/os-config-bare-bones.texi \
59 %D%/os-config-desktop.texi \
60 %D%/os-config-lightweight-desktop.texi
61
62 TRANSLATED_INFO = \
63 %D%/guix.de.texi \
64 %D%/guix.es.texi \
65 %D%/guix.fr.texi \
66 %D%/guix.ru.texi \
67 %D%/guix.zh_CN.texi \
68 %D%/contributing.de.texi \
69 %D%/contributing.es.texi \
70 %D%/contributing.fr.texi \
71 %D%/contributing.ru.texi \
72 %D%/contributing.zh_CN.texi
73
74 # Bundle this file so that makeinfo finds it in out-of-source-tree builds.
75 BUILT_SOURCES += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
76 EXTRA_DIST += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
77 MAINTAINERCLEANFILES = $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
78
79 PO4A_PARAMS := -M UTF-8 -L UTF-8 #master and localized encoding
80 PO4A_PARAMS += -k 0 # produce an output even if the translation is not complete
81 PO4A_PARAMS += -f texinfo # texinfo format
82
83 # When a change to guix.texi occurs, it is not translated immediately.
84 # Because @pxref and @xref commands are reference to a section by name, they
85 # should be translated. If a modification adds a reference to a section, this
86 # reference is not translated, which means it references a section that does not
87 # exist.
88 # This command loops through the translated files looking for references. For
89 # each of these references, it tries to find the translation and replaces the
90 # reference name, even in untranslated strings.
91 # The last sed is a multiline sed because some references span multiple lines.
92 define xref_command
93 cat "$@.tmp" | egrep '@p?x?ref' -A1 | sed 'N;s|--\n||g;P;D' | sed 's|^| |g' | \
94 tr -d '\012' | sed 's|\(@p\?x\?ref\)|\n\1|g' | egrep '@p?x?ref' | \
95 sed 's|^.*@p\?x\?ref{\([^,}]*\).*$$|\1|g' | sort | uniq | while read e; do \
96 line=$$(grep -n "^msgid \"$$e\"" "$<" | cut -f1 --delimiter=":") ;\
97 ((line++)) ;\
98 if [ "$$line" != "1" ]; then \
99 translation=$$(head -n $$line "$<" | tail -1 | grep msgstr | sed 's|msgstr "\(.*\)"|\1|') ;\
100 if [ "$$translation" != "" ]; then \
101 sed "N;s@\(p\?x\?ref\){$$(echo $$e | sed 's| |[\\n ]|g')\(,\|}\)@\1{$$translation\2@g;P;D" -i "$@.tmp" ;\
102 fi ;\
103 fi ;\
104 done
105 endef
106
107 $(srcdir)/%D%/guix.%.texi: po/doc/guix-manual.%.po $(srcdir)/%D%/contributing.%.texi
108 -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix.texi" -p "$<" -l "$@.tmp"
109 -sed -i "s|guix\.info|$$(basename "$@" | sed 's|texi$$|info|')|" "$@.tmp"
110 -$(AM_V_POXREF)$(xref_command)
111 -mv "$@.tmp" "$@"
112
113 $(srcdir)/%D%/guix-cookbook.%.texi: po/doc/guix-cookbook.%.po
114 -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix-cookbook.texi" -p "$<" -l "$@.tmp"
115 -sed -i "s|guix-cookbook\.info|$$(basename "$@" | sed 's|texi$$|info|')|" "$@.tmp"
116 -$(AM_V_POXREF)$(xref_command)
117 -mv "$@.tmp" "$@"
118
119 $(srcdir)/%D%/contributing.%.texi: po/doc/guix-manual.%.po
120 -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/contributing.texi" -p "$<" -l "$@.tmp"
121 -$(AM_V_POXREF)$(xref_command)
122 -mv "$@.tmp" "$@"
123
124 %D%/os-config-%.texi: gnu/system/examples/%.tmpl
125 $(AM_V_GEN)$(MKDIR_P) "`dirname $@`"; \
126 cp "$<" "$@"
127
128 infoimagedir = $(infodir)/images
129 dist_infoimage_DATA = \
130 $(DOT_FILES:%.dot=%.png) \
131 %D%/images/coreutils-size-map.png \
132 %D%/images/installer-network.png \
133 %D%/images/installer-partitions.png \
134 %D%/images/installer-resume.png
135
136 # Ask for warnings about cross-referenced manuals that are not listed in
137 # htmlxref.cnf.
138 AM_MAKEINFOHTMLFLAGS = --set-customization-variable CHECK_HTMLXREF=true
139
140 # Try hard to obtain an image size and aspect that's reasonable for inclusion
141 # in an Info or PDF document.
142 DOT_OPTIONS = \
143 -Gratio=.9 -Gnodesep=.005 -Granksep=.00005 \
144 -Nfontsize=9 -Nheight=.1 -Nwidth=.1
145
146 .dot.png:
147 $(AM_V_DOT)$(DOT) -Tpng $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
148 mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
149
150 .dot.pdf:
151 $(AM_V_DOT)$(DOT) -Tpdf $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
152 mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
153
154 .dot.eps:
155 $(AM_V_DOT)$(DOT) -Teps $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
156 mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
157
158 .png.eps:
159 $(AM_V_GEN)convert "$<" "$@-tmp.eps"; \
160 mv "$@-tmp.eps" "$@"
161
162 # We cannot add new dependencies to `%D%/guix.pdf' & co. (info "(automake)
163 # Extending"). Using the `-local' rules is imperfect, because they may be
164 # triggered after the main rule. Oh, well.
165 pdf-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.pdf)
166 info-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.png)
167 ps-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.eps) \
168 $(top_srcdir)/%D%/images/coreutils-size-map.eps
169 dvi-local: ps-local
170
171 ## ----------- ##
172 ## Man pages. ##
173 ## ----------- ##
174
175 # The man pages are generated using GNU Help2man. In makefiles rules they
176 # depend not on the binary, but on the source files. This usage allows a
177 # manual page to be generated by the maintainer and included in the
178 # distribution without requiring the end-user to have 'help2man' installed.
179 # They are built in $(srcdir) like info manuals.
180
181 sub_commands_mans = \
182 $(srcdir)/%D%/guix-archive.1 \
183 $(srcdir)/%D%/guix-build.1 \
184 $(srcdir)/%D%/guix-challenge.1 \
185 $(srcdir)/%D%/guix-download.1 \
186 $(srcdir)/%D%/guix-edit.1 \
187 $(srcdir)/%D%/guix-environment.1 \
188 $(srcdir)/%D%/guix-gc.1 \
189 $(srcdir)/%D%/guix-hash.1 \
190 $(srcdir)/%D%/guix-import.1 \
191 $(srcdir)/%D%/guix-lint.1 \
192 $(srcdir)/%D%/guix-package.1 \
193 $(srcdir)/%D%/guix-publish.1 \
194 $(srcdir)/%D%/guix-pull.1 \
195 $(srcdir)/%D%/guix-refresh.1 \
196 $(srcdir)/%D%/guix-size.1 \
197 $(srcdir)/%D%/guix-system.1
198
199 dist_man1_MANS = \
200 $(srcdir)/%D%/guix.1 \
201 $(sub_commands_mans)
202
203 gen_man = \
204 LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN) \
205 $(HELP2MANFLAGS)
206
207 HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)
208
209 $(srcdir)/%D%/guix.1: scripts/guix.in $(sub_commands_mans)
210 -$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
211
212 # The 'case' ensures the man pages are only generated if the corresponding
213 # source script (the first prerequisite) has been changed. The $(GOBJECTS)
214 # prerequisite is solely meant to force these docs to be made only after all
215 # Guile modules have been compiled.
216 $(srcdir)/%D%/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
217 -@case '$?' in \
218 *$<*) $(AM_V_P) && set -x || echo " HELP2MAN $@"; \
219 $(gen_man) --output="$@" "guix $*";; \
220 *) : ;; \
221 esac
222
223 if BUILD_DAEMON
224
225 dist_man1_MANS += $(srcdir)/%D%/guix-daemon.1
226
227 $(srcdir)/%D%/guix-daemon.1: nix/nix-daemon/guix-daemon.cc
228 -$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
229
230 endif