X-Git-Url: http://git.hcoop.net/jackhill/guix/guix.git/blobdiff_plain/8c14f7f8a7ab0722bf4c9f92fd28ae85514d564f..934b0cdfee2078bad42429427e12d6ee2ddb7fec:/doc/local.mk diff --git a/doc/local.mk b/doc/local.mk index 4ad19b5e37..9619971296 100644 --- a/doc/local.mk +++ b/doc/local.mk @@ -1,10 +1,10 @@ # GNU Guix --- Functional package management for GNU # Copyright © 2016 Eric Bavier -# Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Ludovic Courtès +# Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020 Ludovic Courtès # Copyright © 2013 Andreas Enge # Copyright © 2016 Taylan Ulrich Bayırlı/Kammer # Copyright © 2016, 2018 Mathieu Lirzin -# Copyright © 2018 Julien Lepiller +# Copyright © 2018, 2021 Julien Lepiller # # This file is part of GNU Guix. # @@ -21,9 +21,38 @@ # You should have received a copy of the GNU General Public License # along with GNU Guix. If not, see . -info_TEXINFOS = %D%/guix.texi \ - %D%/guix.fr.texi \ - %D%/guix.de.texi +# If adding a language, update the following variables, and info_TEXINFOS. +MANUAL_LANGUAGES = de es fa fi fr it ko pt_BR ru sk zh_CN +COOKBOOK_LANGUAGES = de es fa fi fr ko ru sk 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 \ + %D%/guix.fa.texi \ + %D%/guix.fi.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%/guix-cookbook.texi \ + %D%/guix-cookbook.de.texi \ + %D%/guix-cookbook.es.texi \ + %D%/guix-cookbook.fa.texi \ + %D%/guix-cookbook.fi.texi \ + %D%/guix-cookbook.fr.texi \ + %D%/guix-cookbook.ko.texi \ + %D%/guix-cookbook.ru.texi \ + %D%/guix-cookbook.sk.texi \ + %D%/guix-cookbook.zh_Hans.texi %C%_guix_TEXINFOS = \ %D%/contributing.texi \ @@ -34,7 +63,7 @@ DOT_FILES = \ %D%/images/bootstrap-packages.dot \ %D%/images/coreutils-graph.dot \ %D%/images/coreutils-bag-graph.dot \ - %D%/images/gcc-mesboot-bag-graph.dot \ + %D%/images/gcc-core-mesboot0-graph.dot \ %D%/images/service-graph.dot \ %D%/images/shepherd-graph.dot @@ -48,18 +77,19 @@ EXTRA_DIST += \ $(DOT_VECTOR_GRAPHICS) \ %D%/images/coreutils-size-map.eps \ %D%/environment-gdb.scm \ - %D%/package-hello.scm + %D%/package-hello.scm \ + %D%/package-hello.json OS_CONFIG_EXAMPLES_TEXI = \ %D%/os-config-bare-bones.texi \ %D%/os-config-desktop.texi \ - %D%/os-config-lightweight-desktop.texi + %D%/os-config-lightweight-desktop.texi \ + %D%/he-config-bare-bones.scm -TRANSLATED_INFO = \ - %D%/guix.de.texi \ - %D%/guix.fr.texi \ - %D%/contributing.de.texi \ - %D%/contributing.fr.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) @@ -71,38 +101,31 @@ 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 +# Because @pxref and @xref commands are references to sections 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 +$(top_srcdir)/pre-inst-env $(GUILE) --no-auto-compile \ + "$(top_srcdir)/build-aux/convert-xref.scm" \ + $@.tmp $< endef -$(srcdir)/%D%/guix.%.texi: po/doc/guix-manual.%.po $(srcdir)/%D%/contributing.%.texi +$(srcdir)/%D%/guix.%.texi: po/doc/guix-manual.%.po $(srcdir)/%D%/contributing.%.texi guix/build/po.go -$(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) + -$(AM_V_POXREF)LC_ALL=en_US.UTF-8 $(xref_command) -mv "$@.tmp" "$@" -$(srcdir)/%D%/contributing.%.texi: po/doc/guix-manual.%.po +$(srcdir)/%D%/guix-cookbook.%.texi: po/doc/guix-cookbook.%.po guix/build/po.go + -$(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)LC_ALL=en_US.UTF-8 $(xref_command) + -mv "$@.tmp" "$@" + +$(srcdir)/%D%/contributing.%.texi: po/doc/guix-manual.%.po guix/build/po.go -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/contributing.texi" -p "$<" -l "$@.tmp" - -$(AM_V_POXREF)$(xref_command) + -$(AM_V_POXREF)LC_ALL=en_US.UTF-8 $(xref_command) -mv "$@.tmp" "$@" %D%/os-config-%.texi: gnu/system/examples/%.tmpl @@ -117,6 +140,10 @@ dist_infoimage_DATA = \ %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. DOT_OPTIONS = \ @@ -162,6 +189,7 @@ sub_commands_mans = \ $(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 \ @@ -174,12 +202,19 @@ sub_commands_mans = \ $(srcdir)/%D%/guix-pull.1 \ $(srcdir)/%D%/guix-refresh.1 \ $(srcdir)/%D%/guix-size.1 \ - $(srcdir)/%D%/guix-system.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)/%D%/guix.1 \ $(sub_commands_mans) +endif + gen_man = \ LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN) \ $(HELP2MANFLAGS) @@ -201,10 +236,12 @@ $(srcdir)/%D%/guix-%.1: guix/scripts/%.scm $(GOBJECTS) esac if BUILD_DAEMON +if !CROSS_COMPILING dist_man1_MANS += $(srcdir)/%D%/guix-daemon.1 -$(srcdir)/%D%/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