aboutsummaryrefslogtreecommitdiff
path: root/doc.am
blob: 045e93056c87d2ca37c72b2bc7514b9c5d978148 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# GNU Guix --- Functional package management for GNU
# Copyright © 2012, 2013, 2014, 2015, 2016 Ludovic Courtès <ludo@gnu.org>
# Copyright © 2013 Andreas Enge <andreas@enge.fr>
# Copyright © 2016 Taylan Ulrich Bayırlı/Kammer <taylanbayirli@gmail.com>
#
# 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 = doc/guix.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/dmd-graph.dot

DOT_VECTOR_GRAPHICS =				\
  $(DOT_FILES:%.dot=%.eps)			\
  $(DOT_FILES:%.dot=%.pdf)

EXTRA_DIST +=					\
  doc/contributing.texi				\
  doc/emacs.texi				\
  doc/fdl-1.3.texi				\
  $(DOT_FILES)					\
  $(DOT_VECTOR_GRAPHICS)			\
  doc/images/coreutils-size-map.eps		\
  doc/environment-gdb.scm			\
  doc/package-hello.scm

OS_CONFIG_EXAMPLES_TEXI =			\
  doc/os-config-bare-bones.texi			\
  doc/os-config-desktop.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
	$(MKDIR_P) "`dirname "$@"`"
	cp "$<" "$@"

infoimagedir = $(infodir)/images
dist_infoimage_DATA =				\
  $(DOT_FILES:%.dot=%.png)			\
  doc/images/coreutils-size-map.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:
	convert "$<" "$@-tmp.eps"
	mv "$@-tmp.eps" "$@"

# We cannot add new dependencies to `doc/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
dvi-local: ps-local


# Manual pages.

doc/guix.1: $(SUBCOMMANDS:%=guix/scripts/%.scm)
	-LANGUAGE= $(top_builddir)/pre-inst-env	\
	  $(HELP2MAN) --output="$@" guix

# Note: Do not depend on 'guix-daemon' since that would trigger a rebuild even
# for people building from a tarball.
doc/guix-daemon.1: nix/nix-daemon/guix-daemon.cc
	-LANGUAGE= $(top_builddir)/pre-inst-env	\
	  $(HELP2MAN) --output="$@" guix-daemon

define subcommand-manual-target

doc/guix-$(1).1: guix/scripts/$(1).scm
	-LANGUAGE= $(top_builddir)/pre-inst-env		\
	  $(HELP2MAN) --output="$$@" "guix $(1)"

endef

SUBCOMMANDS :=					\
  archive					\
  build						\
  challenge					\
  download					\
  edit						\
  environment					\
  gc						\
  hash						\
  import					\
  lint						\
  package					\
  publish					\
  pull						\
  refresh					\
  size						\
  system

$(eval $(foreach subcommand,$(SUBCOMMANDS),			\
          $(call subcommand-manual-target,$(subcommand))))

dist_man1_MANS =				\
  doc/guix.1					\
  $(SUBCOMMANDS:%=doc/guix-%.1)

if BUILD_DAEMON

dist_man1_MANS +=				\
  doc/guix-daemon.1

endif