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 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.fr.texi \
  26   %D%/guix.de.texi
  27
  28 %C%_guix_TEXINFOS = \
  29   %D%/contributing.texi \
  30   %D%/fdl-1.3.texi
  31
  32 DOT_FILES =                                     \
  33   %D%/images/bootstrap-graph.dot                \
  34   %D%/images/bootstrap-packages.dot             \
  35   %D%/images/coreutils-graph.dot                \
  36   %D%/images/coreutils-bag-graph.dot            \
  37   %D%/images/service-graph.dot                  \
  38   %D%/images/shepherd-graph.dot
  39
  40 DOT_VECTOR_GRAPHICS =                           \
  41   $(DOT_FILES:%.dot=%.eps)                      \
  42   $(DOT_FILES:%.dot=%.pdf)
  43
  44 EXTRA_DIST +=                                   \
  45   %D%/htmlxref.cnf                              \
  46   $(DOT_FILES)                                  \
  47   $(DOT_VECTOR_GRAPHICS)                        \
  48   %D%/images/coreutils-size-map.eps             \
  49   %D%/environment-gdb.scm                       \
  50   %D%/package-hello.scm
  51
  52 OS_CONFIG_EXAMPLES_TEXI =                       \
  53   %D%/os-config-bare-bones.texi                 \
  54   %D%/os-config-desktop.texi                    \
  55   %D%/os-config-lightweight-desktop.texi
  56
  57 TRANSLATED_INFO = \
  58   %D%/guix.de.texi \
  59   %D%/guix.fr.texi \
  60   %D%/contributing.de.texi \
  61   %D%/contributing.fr.texi
  62
  63 # Bundle this file so that makeinfo finds it in out-of-source-tree builds.
  64 BUILT_SOURCES        += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
  65 EXTRA_DIST           += $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
  66 MAINTAINERCLEANFILES  = $(OS_CONFIG_EXAMPLES_TEXI) $(TRANSLATED_INFO)
  67
  68 PO4A_PARAMS := -M UTF-8 -L UTF-8 #master and localized encoding
  69 PO4A_PARAMS += -k 0 # produce an output even if the translation is not complete
  70 PO4A_PARAMS += -f texinfo # texinfo format
  71
  72 # When a change to guix.texi occurs, it is not translated immediately.
  73 # Because @pxref and @xref commands are reference to a section by name, they
  74 # should be translated. If a modification adds a reference to a section, this
  75 # reference is not translated, which means it references a section that does not
  76 # exist.
  77 # This command loops through the translated files looking for references. For
  78 # each of these references, it tries to find the translation and replaces the
  79 # reference name, even in untranslated strings.
  80 # The last sed is a multiline sed because some references span multiple lines.
  81 define xref_command
  82 cat "$@.tmp" | egrep '@p?x?ref' -A1 | sed 'N;s|--\n||g;P;D' | sed 's|^| |g' | \
  83         tr -d '\012' | sed 's|\(@p\?x\?ref\)|\n\1|g' | egrep '@p?x?ref' | \
  84         sed 's|^.*@p\?x\?ref{\([^,}]*\).*$$|\1|g' | sort | uniq | while read e; do \
  85   line=$$(grep -n "^msgid \"$$e\"" "$<" | cut -f1 --delimiter=":") ;\
  86   ((line++)) ;\
  87   if [ "$$line" != "1" ]; then \
  88     translation=$$(head -n $$line "$<" | tail -1 | grep msgstr | sed 's|msgstr "\(.*\)"|\1|') ;\
  89     if [ "$$translation" != "" ]; then \
  90           sed "N;s@\(p\?x\?ref\){$$(echo $$e | sed 's| |[\\n ]|g')\(,\|}\)@\1{$$translation\2@g;P;D" -i "$@.tmp" ;\
  91     fi ;\
  92   fi ;\
  93 done
  94 endef
  95
  96 $(srcdir)/%D%/guix.%.texi: po/doc/guix-manual.%.po $(srcdir)/%D%/contributing.%.texi
  97         -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/guix.texi" -p "$<" -l "$@.tmp"
  98         -sed -i "s|guix\.info|$$(basename "$@" | sed 's|texi$$|info|')|" "$@.tmp"
  99         -$(AM_V_POXREF)$(xref_command)
 100         -mv "$@.tmp" "$@"
 101
 102 $(srcdir)/%D%/contributing.%.texi: po/doc/guix-manual.%.po
 103         -$(AM_V_PO4A)$(PO4A_TRANSLATE) $(PO4A_PARAMS) -m "%D%/contributing.texi" -p "$<" -l "$@.tmp"
 104         -$(AM_V_POXREF)$(xref_command)
 105         -mv "$@.tmp" "$@"
 106
 107 %D%/os-config-%.texi: gnu/system/examples/%.tmpl
 108         $(AM_V_GEN)$(MKDIR_P) "`dirname $@`";   \
 109         cp "$<" "$@"
 110
 111 infoimagedir = $(infodir)/images
 112 dist_infoimage_DATA =                           \
 113   $(DOT_FILES:%.dot=%.png)                      \
 114   %D%/images/coreutils-size-map.png
 115
 116 # Try hard to obtain an image size and aspect that's reasonable for inclusion
 117 # in an Info or PDF document.
 118 DOT_OPTIONS =                                   \
 119   -Gratio=.9 -Gnodesep=.005 -Granksep=.00005    \
 120   -Nfontsize=9 -Nheight=.1 -Nwidth=.1
 121
 122 .dot.png:
 123         $(AM_V_DOT)$(DOT) -Tpng $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
 124         mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
 125
 126 .dot.pdf:
 127         $(AM_V_DOT)$(DOT) -Tpdf $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
 128         mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
 129
 130 .dot.eps:
 131         $(AM_V_DOT)$(DOT) -Teps $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
 132         mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"
 133
 134 .png.eps:
 135         $(AM_V_GEN)convert "$<" "$@-tmp.eps"; \
 136         mv "$@-tmp.eps" "$@"
 137
 138 # We cannot add new dependencies to `%D%/guix.pdf' & co. (info "(automake)
 139 # Extending").  Using the `-local' rules is imperfect, because they may be
 140 # triggered after the main rule.  Oh, well.
 141 pdf-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.pdf)
 142 info-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.png)
 143 ps-local: $(DOT_FILES=%.dot=$(top_srcdir)/%.eps)                \
 144           $(top_srcdir)/%D%/images/coreutils-size-map.eps
 145 dvi-local: ps-local
 146
 147 ## ----------- ##
 148 ##  Man pages. ##
 149 ## ----------- ##
 150
 151 # The man pages are generated using GNU Help2man.  In makefiles rules they
 152 # depend not on the binary, but on the source files.  This usage allows a
 153 # manual page to be generated by the maintainer and included in the
 154 # distribution without requiring the end-user to have 'help2man' installed.
 155 # They are built in $(srcdir) like info manuals.
 156
 157 sub_commands_mans =                             \
 158   $(srcdir)/%D%/guix-archive.1                  \
 159   $(srcdir)/%D%/guix-build.1                    \
 160   $(srcdir)/%D%/guix-challenge.1                \
 161   $(srcdir)/%D%/guix-download.1                 \
 162   $(srcdir)/%D%/guix-edit.1                     \
 163   $(srcdir)/%D%/guix-environment.1              \
 164   $(srcdir)/%D%/guix-gc.1                       \
 165   $(srcdir)/%D%/guix-hash.1                     \
 166   $(srcdir)/%D%/guix-import.1                   \
 167   $(srcdir)/%D%/guix-lint.1                     \
 168   $(srcdir)/%D%/guix-package.1                  \
 169   $(srcdir)/%D%/guix-publish.1                  \
 170   $(srcdir)/%D%/guix-pull.1                     \
 171   $(srcdir)/%D%/guix-refresh.1                  \
 172   $(srcdir)/%D%/guix-size.1                     \
 173   $(srcdir)/%D%/guix-system.1
 174
 175 dist_man1_MANS =                                \
 176   $(srcdir)/%D%/guix.1                          \
 177   $(sub_commands_mans)
 178
 179 gen_man =                                               \
 180   LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN)    \
 181   $(HELP2MANFLAGS)
 182
 183 HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)
 184
 185 $(srcdir)/%D%/guix.1: scripts/guix.in $(sub_commands_mans)
 186         -$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
 187
 188 # The 'case' ensures the man pages are only generated if the corresponding
 189 # source script (the first prerequisite) has been changed.  The $(GOBJECTS)
 190 # prerequisite is solely meant to force these docs to be made only after all
 191 # Guile modules have been compiled.
 192 $(srcdir)/%D%/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
 193         -@case '$?' in \
 194           *$<*) $(AM_V_P) && set -x || echo "  HELP2MAN $@"; \
 195                 $(gen_man) --output="$@" "guix $*";; \
 196           *)    : ;; \
 197         esac
 198
 199 if BUILD_DAEMON
 200
 201 dist_man1_MANS += $(srcdir)/%D%/guix-daemon.1
 202
 203 $(srcdir)/%D%/guix-daemon.1: nix/nix-daemon/guix-daemon.cc
 204         -$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`
 205
 206 endif