# GNU Guix --- Functional package management for GNU
# Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
-# Copyright © 2012, 2013, 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
+# Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès <ludo@gnu.org>
# Copyright © 2013 Andreas Enge <andreas@enge.fr>
# Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com>
-# Copyright © 2016 Mathieu Lirzin <mthl@gnu.org>
+# Copyright © 2016, 2018 Mathieu Lirzin <mthl@gnu.org>
+# Copyright © 2018 Julien Lepiller <julien@lepiller.eu>
#
# This file is part of GNU Guix.
#
# You should have received a copy of the GNU General Public License
# along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
-info_TEXINFOS = doc/guix.texi
+info_TEXINFOS = %D%/guix.texi \
+ %D%/guix.de.texi \
+ %D%/guix.es.texi \
+ %D%/guix.fr.texi \
+ %D%/guix.ru.texi \
+ %D%/guix.zh_CN.texi \
+ %D%/guix-cookbook.texi \
+ %D%/guix-cookbook.de.texi
+
+%C%_guix_TEXINFOS = \
+ %D%/contributing.texi \
+ %D%/fdl-1.3.texi
DOT_FILES = \
- doc/images/bootstrap-graph.dot \
- doc/images/bootstrap-packages.dot \
- doc/images/coreutils-graph.dot \
- doc/images/coreutils-bag-graph.dot \
- doc/images/service-graph.dot \
- doc/images/shepherd-graph.dot
+ %D%/images/bootstrap-graph.dot \
+ %D%/images/bootstrap-packages.dot \
+ %D%/images/coreutils-graph.dot \
+ %D%/images/coreutils-bag-graph.dot \
+ %D%/images/gcc-core-mesboot0-graph.dot \
+ %D%/images/service-graph.dot \
+ %D%/images/shepherd-graph.dot
DOT_VECTOR_GRAPHICS = \
$(DOT_FILES:%.dot=%.eps) \
$(DOT_FILES:%.dot=%.pdf)
EXTRA_DIST += \
- doc/htmlxref.cnf \
- doc/contributing.texi \
- doc/emacs.texi \
- doc/fdl-1.3.texi \
+ %D%/htmlxref.cnf \
$(DOT_FILES) \
$(DOT_VECTOR_GRAPHICS) \
- doc/images/coreutils-size-map.eps \
- doc/environment-gdb.scm \
- doc/package-hello.scm
+ %D%/images/coreutils-size-map.eps \
+ %D%/environment-gdb.scm \
+ %D%/package-hello.scm \
+ %D%/package-hello.json
OS_CONFIG_EXAMPLES_TEXI = \
- doc/os-config-bare-bones.texi \
- doc/os-config-desktop.texi \
- doc/os-config-lightweight-desktop.texi
+ %D%/os-config-bare-bones.texi \
+ %D%/os-config-desktop.texi \
+ %D%/os-config-lightweight-desktop.texi
+
+TRANSLATED_INFO = \
+ %D%/guix.de.texi \
+ %D%/guix.es.texi \
+ %D%/guix.fr.texi \
+ %D%/guix.ru.texi \
+ %D%/guix.zh_CN.texi \
+ %D%/contributing.de.texi \
+ %D%/contributing.es.texi \
+ %D%/contributing.fr.texi \
+ %D%/contributing.ru.texi \
+ %D%/contributing.zh_CN.texi \
+ %D%/guix-cookbook.de.texi
# Bundle this file so that makeinfo finds it in out-of-source-tree builds.
-BUILT_SOURCES += $(OS_CONFIG_EXAMPLES_TEXI)
-EXTRA_DIST += $(OS_CONFIG_EXAMPLES_TEXI)
-MAINTAINERCLEANFILES = $(OS_CONFIG_EXAMPLES_TEXI)
-
-doc/os-config-%.texi: gnu/system/examples/%.tmpl
+BUILT_SOURCES += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
+EXTRA_DIST += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
+MAINTAINERCLEANFILES = $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
+
+PO4A_PARAMS := -M UTF-8 -L UTF-8 #master and localized encoding
+PO4A_PARAMS += -k 0 # produce an output even if the translation is not complete
+PO4A_PARAMS += -f texinfo # texinfo format
+
+# When a change to guix.texi occurs, it is not translated immediately.
+# Because @pxref and @xref commands are reference to a section by name, they
+# should be translated. If a modification adds a reference to a section, this
+# reference is not translated, which means it references a section that does not
+# exist.
+# This command loops through the translated files looking for references. For
+# each of these references, it tries to find the translation and replaces the
+# reference name, even in untranslated strings.
+# The last sed is a multiline sed because some references span multiple lines.
+define xref_command
+cat "$@.tmp" | egrep '@p?x?ref' -A1 | sed 'N;s|--\n||g;P;D' | sed 's|^| |g' | \
+ tr -d '\012' | sed 's|\(@p\?x\?ref\)|\n\1|g' | egrep '@p?x?ref' | \
+ sed 's|^.*@p\?x\?ref{\([^,}]*\).*$$|\1|g' | sort | uniq | while read e; do \
+ line=$$(grep -n "^msgid \"$$e\"" "$<" | cut -f1 --delimiter=":") ;\
+ ((line++)) ;\
+ if [ "$$line" != "1" ]; then \
+ translation=$$(head -n $$line "$<" | tail -1 | grep msgstr | sed 's|msgstr "\(.*\)"|\1|') ;\
+ if [ "$$translation" != "" ]; then \
+ sed "N;s@\(p\?x\?ref\){$$(echo $$e | sed 's| |[\\n ]|g')\(,\|}\)@\1{$$translation\2@g;P;D" -i "$@.tmp" ;\
+ fi ;\
+ fi ;\
+done
+endef
+
+$(srcdir)/%D%/guix.%.texi: po/doc/guix-manual.%.po $(srcdir)/%D%/contributing.%.texi
+ -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix.texi" -p "$<" -l "$@.tmp"
+ -sed -i "s|guix\.info|$$(basename "$@" | sed 's|texi$$|info|')|" "$@.tmp"
+ -$(AM_V_POXREF)$(xref_command)
+ -mv "$@.tmp" "$@"
+
+$(srcdir)/%D%/guix-cookbook.%.texi: po/doc/guix-cookbook.%.po
+ -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix-cookbook.texi" -p "$<" -l "$@.tmp"
+ -sed -i "s|guix-cookbook\.info|$$(basename "$@" | sed 's|texi$$|info|')|" "$@.tmp"
+ -$(AM_V_POXREF)$(xref_command)
+ -mv "$@.tmp" "$@"
+
+$(srcdir)/%D%/contributing.%.texi: po/doc/guix-manual.%.po
+ -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/contributing.texi" -p "$<" -l "$@.tmp"
+ -$(AM_V_POXREF)$(xref_command)
+ -mv "$@.tmp" "$@"
+
+%D%/os-config-%.texi: gnu/system/examples/%.tmpl
$(AM_V_GEN)$(MKDIR_P) "`dirname $@`"; \
cp "$<" "$@"
infoimagedir = $(infodir)/images
dist_infoimage_DATA = \
$(DOT_FILES:%.dot=%.png) \
- doc/images/coreutils-size-map.png
+ %D%/images/coreutils-size-map.png \
+ %D%/images/installer-network.png \
+ %D%/images/installer-partitions.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
# in an Info or PDF document.
$(AM_V_GEN)convert "$<" "$@-tmp.eps"; \
mv "$@-tmp.eps" "$@"
-# We cannot add new dependencies to `doc/guix.pdf' & co. (info "(automake)
+# We cannot add new dependencies to `%D%/guix.pdf' & co. (info "(automake)
# Extending"). Using the `-local' rules is imperfect, because they may be
# triggered after the main rule. Oh, well.
pdf-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.pdf)
info-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.png)
ps-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.eps) \
- $(top_srcdir)/doc/images/coreutils-size-map.eps
+ $(top_srcdir)/%D%/images/coreutils-size-map.eps
dvi-local: ps-local
## ----------- ##
# They are built in $(srcdir) like info manuals.
sub_commands_mans = \
- $(srcdir)/doc/guix-archive.1 \
- $(srcdir)/doc/guix-build.1 \
- $(srcdir)/doc/guix-challenge.1 \
- $(srcdir)/doc/guix-download.1 \
- $(srcdir)/doc/guix-edit.1 \
- $(srcdir)/doc/guix-environment.1 \
- $(srcdir)/doc/guix-gc.1 \
- $(srcdir)/doc/guix-hash.1 \
- $(srcdir)/doc/guix-import.1 \
- $(srcdir)/doc/guix-lint.1 \
- $(srcdir)/doc/guix-package.1 \
- $(srcdir)/doc/guix-publish.1 \
- $(srcdir)/doc/guix-pull.1 \
- $(srcdir)/doc/guix-refresh.1 \
- $(srcdir)/doc/guix-size.1 \
- $(srcdir)/doc/guix-system.1
+ $(srcdir)/%D%/guix-archive.1 \
+ $(srcdir)/%D%/guix-build.1 \
+ $(srcdir)/%D%/guix-challenge.1 \
+ $(srcdir)/%D%/guix-deploy.1 \
+ $(srcdir)/%D%/guix-download.1 \
+ $(srcdir)/%D%/guix-edit.1 \
+ $(srcdir)/%D%/guix-environment.1 \
+ $(srcdir)/%D%/guix-gc.1 \
+ $(srcdir)/%D%/guix-hash.1 \
+ $(srcdir)/%D%/guix-import.1 \
+ $(srcdir)/%D%/guix-lint.1 \
+ $(srcdir)/%D%/guix-package.1 \
+ $(srcdir)/%D%/guix-publish.1 \
+ $(srcdir)/%D%/guix-pull.1 \
+ $(srcdir)/%D%/guix-refresh.1 \
+ $(srcdir)/%D%/guix-size.1 \
+ $(srcdir)/%D%/guix-system.1 \
+ $(srcdir)/%D%/guix-time-machine.1 \
+ $(srcdir)/%D%/guix-weather.1
+
+# Assume that cross-compiled commands cannot be executed.
+if !CROSS_COMPILING
dist_man1_MANS = \
- $(srcdir)/doc/guix.1 \
+ $(srcdir)/%D%/guix.1 \
$(sub_commands_mans)
+endif
+
gen_man = \
LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN) \
$(HELP2MANFLAGS)
HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)
-$(srcdir)/doc/guix.1: scripts/guix.in $(sub_commands_mans)
+$(srcdir)/%D%/guix.1: scripts/guix.in $(sub_commands_mans)
-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
# The 'case' ensures the man pages are only generated if the corresponding
# source script (the first prerequisite) has been changed. The $(GOBJECTS)
# prerequisite is solely meant to force these docs to be made only after all
# Guile modules have been compiled.
-$(srcdir)/doc/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
+$(srcdir)/%D%/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
-@case '$?' in \
*$<*) $(AM_V_P) && set -x || echo " HELP2MAN $@"; \
$(gen_man) --output="$@" "guix $*";; \
esac
if BUILD_DAEMON
+if !CROSS_COMPILING
-dist_man1_MANS += $(srcdir)/doc/guix-daemon.1
+dist_man1_MANS += $(srcdir)/%D%/guix-daemon.1
-$(srcdir)/doc/guix-daemon.1: nix/nix-daemon/guix-daemon.cc
+$(srcdir)/%D%/guix-daemon.1: guix-daemon$(EXEEXT)
-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
endif
+endif