[jackhill/guix/guix.git] / doc / local.mk

# GNU Guix --- Functional package management for GNU
# Copyright © 2016 Eric Bavier <bavier@member.fsf.org>
# Copyright © 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 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, 2018 Mathieu Lirzin <mthl@gnu.org>
# Copyright © 2018 Julien Lepiller <julien@lepiller.eu>
#
# 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/>.

info_TEXINFOS = %D%/guix.texi \
  %D%/guix.es.texi \
  %D%/guix.fr.texi \
  %D%/guix.de.texi

%C%_guix_TEXINFOS = \
  %D%/contributing.texi \
  %D%/fdl-1.3.texi

DOT_FILES =					\
  %D%/images/bootstrap-graph.dot		\
  %D%/images/bootstrap-packages.dot		\
  %D%/images/coreutils-graph.dot		\
  %D%/images/coreutils-bag-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 +=					\
  %D%/htmlxref.cnf				\
  $(DOT_FILES)					\
  $(DOT_VECTOR_GRAPHICS)			\
  %D%/images/coreutils-size-map.eps		\
  %D%/environment-gdb.scm			\
  %D%/package-hello.scm

OS_CONFIG_EXAMPLES_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%/contributing.de.texi \
  %D%/contributing.es.texi \
  %D%/contributing.fr.texi

# Bundle this file so that makeinfo finds it in out-of-source-tree builds.
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%/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)			\
  %D%/images/coreutils-size-map.png		\
  %D%/images/installer-network.png		\
  %D%/images/installer-partitions.png		\
  %D%/images/installer-resume.png

# Try hard to obtain an image size and aspect that's reasonable for inclusion
# in an Info or PDF document.
DOT_OPTIONS =					\
  -Gratio=.9 -Gnodesep=.005 -Granksep=.00005	\
  -Nfontsize=9 -Nheight=.1 -Nwidth=.1

.dot.png:
	$(AM_V_DOT)$(DOT) -Tpng $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"

.dot.pdf:
	$(AM_V_DOT)$(DOT) -Tpdf $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"

.dot.eps:
	$(AM_V_DOT)$(DOT) -Teps $(DOT_OPTIONS) < "$<" > "$(srcdir)/$@.tmp"; \
	mv "$(srcdir)/$@.tmp" "$(srcdir)/$@"

.png.eps:
	$(AM_V_GEN)convert "$<" "$@-tmp.eps"; \
	mv "$@-tmp.eps" "$@"

# 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)/%D%/images/coreutils-size-map.eps
dvi-local: ps-local

## ----------- ##
##  Man pages. ##
## ----------- ##

# The man pages are generated using GNU Help2man.  In makefiles rules they
# depend not on the binary, but on the source files.  This usage allows a
# manual page to be generated by the maintainer and included in the
# distribution without requiring the end-user to have 'help2man' installed.
# They are built in $(srcdir) like info manuals.

sub_commands_mans =				\
  $(srcdir)/%D%/guix-archive.1			\
  $(srcdir)/%D%/guix-build.1			\
  $(srcdir)/%D%/guix-challenge.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

dist_man1_MANS =				\
  $(srcdir)/%D%/guix.1				\
  $(sub_commands_mans)

gen_man =						\
  LANGUAGE= $(top_builddir)/pre-inst-env $(HELP2MAN)	\
  $(HELP2MANFLAGS)

HELP2MANFLAGS = --source=GNU --info-page=$(PACKAGE_TARNAME)

$(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)/%D%/guix-%.1: guix/scripts/%.scm $(GOBJECTS)
	-@case '$?' in \
	  *$<*) $(AM_V_P) && set -x || echo "  HELP2MAN $@"; \
	        $(gen_man) --output="$@" "guix $*";; \
	  *)    : ;; \
	esac

if BUILD_DAEMON

dist_man1_MANS += $(srcdir)/%D%/guix-daemon.1

$(srcdir)/%D%/guix-daemon.1: nix/nix-daemon/guix-daemon.cc
	-$(AM_V_HELP2MAN)$(gen_man) --output="$@" `basename "$@" .1`

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