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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
## -*- mode: makefile -*-
##
## This file is part of the Score-P software (http://www.score-p.org)
##
## Copyright (c) 2009-2011,
## RWTH Aachen University, Germany
##
## Copyright (c) 2009-2011,
## Gesellschaft fuer numerische Simulation mbH Braunschweig, Germany
##
## Copyright (c) 2009-2011, 2019-2020,
## Technische Universitaet Dresden, Germany
##
## Copyright (c) 2009-2011,
## University of Oregon, Eugene, USA
##
## Copyright (c) 2009-2011, 2015,
## Forschungszentrum Juelich GmbH, Germany
##
## Copyright (c) 2009-2011,
## German Research School for Simulation Sciences GmbH, Juelich/Aachen, Germany
##
## Copyright (c) 2009-2011,
## Technische Universitaet Muenchen, Germany
##
## This software may be modified and distributed under the terms of
## a BSD-style license. See the COPYING file in the package base
## directory for details.
##
## file doc/doxygen-user/Makefile.inc.am
###############################################################################
## doxygen related targets
##
## In the following conditional we must distinguish if we are in "developer
## mode", i.e. if we are working on a svn working copy, or if we are in "user
## mode", i.e. we are working on a tarball.
##
## In developer mode we can create doxygen and pdf user documentation (make
## doxygen-user) that will be (automatically) included in the distribution at
## make dist. When creating a distribution, the developer should make sure
## that she has doxygen and related tools e.g. pdflatex in PATH in order to
## generate a complete documentation, see also
## build-config/common/m4/ac_scorep_doxygen.m4.
##
## make install is ignorant of documentation issues in developer mode.
##
## The user gets ready to install documentation in the tarball, i.e. there is no
## need to run doxygen and pdflatex in user mode. In user mode the provided
## documentation is just copied to a subdirectory of $prefix.
DOC_SRC_DIR = $(srcdir)/doc
doxygen-uninstall:
$(AM_V_at)rm -rf $(DESTDIR)$(docdir)
if GIT_CONTROLLED #-----------------------------------------------------------
USER_DOC_DIR = $(top_distdir)$(ac_scorep_doxygen_distdir)/doc
doxygen-user-install:
DIST_HOOK += doxygen-user-pdf doxygen-user-html-compress copy-revision-file-to-dist sphinx-user-generate
update-revision:
@$(am__tty_colors); \
if $(AM_V_P); then echo "cd $(srcdir) && git describe --long --always --dirty | $(SED) 's/.*-g//' > 'build-config/REVISION'"; \
else echo " GEN $${mgn}$(srcdir)/build-config/REVISION$$std"; fi; \
cd $(srcdir) && git describe --long --always --dirty | $(SED) 's/.*-g//' > "build-config/REVISION"
copy-revision-file-to-dist:
$(AM_V_at)$(MKDIR_P) "$(distdir)/build-config/"
$(AM_V_at)cp -p "$(srcdir)/build-config/REVISION" "$(distdir)/build-config/"
$(AM_V_at)case `cat "$(distdir)/build-config/REVISION"` in *-dirty) \
echo >&2 "WARNING: distribution does not match a single, unmodified revision.";; \
esac
doxygen-user-html-compress:
$(AM_V_at)if test -d "$(USER_DOC_DIR)/html"; then \
cd "$(USER_DOC_DIR)"; tar czf html.tar.gz html; rm -rf html/; \
fi
doxygen-project-number: update-revision
$(AM_V_at)echo "PROJECT_NUMBER = \"@PACKAGE_VERSION@ (revision `cat $(srcdir)/build-config/REVISION`)\"" > doc/doxygen-project-number.cfg
CLEANFILES += doc/doxygen-project-number.cfg
CLEAN_LOCAL += doxygen-user-clean
doxygen-user-clean:
$(AM_V_at)rm -rf $(USER_DOC_DIR)/*
if HAVE_DOXYGEN #-----------------------------------------------------
DIST_HOOK += doc/doxygen-user/main.dox
OTF2_V_DOXYGEN = $(otf2__v_DOXYGEN_@AM_V@)
otf2__v_DOXYGEN_ = $(otf2__v_DOXYGEN_@AM_DEFAULT_V@)
otf2__v_DOXYGEN_0 = @$(am__tty_colors); echo " DOXYGEN $${blu}$@$$std";
otf2__v_DOXYGEN_1 =
OTF2_V_DEVNULL = $(otf2__v_DEVNULL_@AM_V@)
otf2__v_DEVNULL_ = $(otf2__v_DEVNULL_@AM_DEFAULT_V@)
otf2__v_DEVNULL_0 = >/dev/null
otf2__v_DEVNULL_1 =
doxygen-user: doxygen-project-number doc/doxygen-user/main.dox doc/doxygen-user.cfg
$(AM_V_at)$(MKDIR_P) "$(USER_DOC_DIR)/tags"
$(AM_V_at)echo "OUTPUT_DIRECTORY = $(USER_DOC_DIR)" > doc/doxygen-user-at-make-time.cfg
$(AM_V_at)echo "GENERATE_TAGFILE = $(USER_DOC_DIR)/tags/@PACKAGE@.tag" >> doc/doxygen-user-at-make-time.cfg
$(AM_V_at)cat doc/doxygen-user.cfg doc/doxygen-project-number.cfg doc/doxygen-user-at-make-time.cfg > doc/doxygen-user-html.cfg
$(AM_V_at)if $(AM_V_P); then echo "QUIET = NO"; \
else echo "QUIET = YES"; fi >>doc/doxygen-user-html.cfg
$(AM_V_at)$(MKDIR_P) "$(USER_DOC_DIR)/html"
$(AM_V_at)cp $(abs_srcdir)/doc/images/* $(USER_DOC_DIR)/html
$(OTF2_V_DOXYGEN)$(DOXYGEN) doc/doxygen-user-html.cfg
doxygen-dev: doxygen-project-number doc/doxygen-user/main.dox doc/doxygen-user.cfg
$(AM_V_at)$(MKDIR_P) "$(USER_DOC_DIR)/tags"
$(AM_V_at)( \
echo "OUTPUT_DIRECTORY = $(USER_DOC_DIR)"; \
echo "GENERATE_TAGFILE = $(USER_DOC_DIR)/tags/@PACKAGE@.tag"; \
echo "INTERNAL_DOCS = YES"; \
echo "INPUT += @abs_top_srcdir@/src"; \
) > doc/doxygen-user-at-make-time.cfg
$(AM_V_at)cat doc/doxygen-user.cfg doc/doxygen-project-number.cfg doc/doxygen-user-at-make-time.cfg > doc/doxygen-user-html.cfg
$(AM_V_at)if $(AM_V_P); then echo "QUIET = NO"; \
else echo "QUIET = YES"; fi >>doc/doxygen-user-html.cfg
$(AM_V_at)$(MKDIR_P) "$(USER_DOC_DIR)/html"
$(AM_V_at)cp $(abs_srcdir)/doc/images/* $(USER_DOC_DIR)/html
$(OTF2_V_DOXYGEN)$(DOXYGEN) doc/doxygen-user-html.cfg
CLEANFILES += doc/doxygen-user-html.cfg doc/doxygen-user-at-make-time.cfg doxygen.err
else # i.e. ! HAVE_DOXYGEN -------------------------------------------
doxygen-user:
@echo "WARNING: doxygen not available. Cannot generate documentation." >&2
doxygen-dev:
@echo "WARNING: doxygen not available. Cannot generate documentation." >&2
endif # HAVE_DOXYGEN -------------------------------------------------
if HAVE_DOXYGEN_LATEX #-----------------------------------------------
OTF2_V_pdflatex = $(otf2__v_pdflatex_@AM_V@)
otf2__v_pdflatex_ = $(otf2__v_pdflatex_@AM_DEFAULT_V@)
otf2__v_pdflatex_0 = -interaction batchmode
otf2__v_pdflatex_1 = -interaction nonstopmode
doxygen-user-pdf: doxygen-user
$(AM_V_at)cat doc/doxygen-user-html.cfg > doc/doxygen-user-pdf.cfg
$(AM_V_at)echo "ENABLED_SECTIONS = LATEX" >> doc/doxygen-user-pdf.cfg
$(AM_V_at)echo "GENERATE_HTML = NO" >> doc/doxygen-user-pdf.cfg
$(AM_V_at)echo "FILE_PATTERNS = *.dox" >> doc/doxygen-user-pdf.cfg
$(AM_V_at)cp $(DOC_SRC_DIR)/license.tex $(USER_DOC_DIR)/pdf/
$(AM_V_at)-cp $(DOC_SRC_DIR)/images/project_logo.pdf $(USER_DOC_DIR)/pdf/
$(AM_V_at)echo "LATEX_CMD_NAME = \"pdflatex -file-line-error $(OTF2_V_pdflatex)\"" >>doc/doxygen-user-pdf.cfg
$(AM_V_at)if $(AM_V_P); then echo "QUIET = NO"; \
else echo "QUIET = YES"; \
echo "MAKEINDEX_CMD_NAME = \"makeindex -q\""; \
fi >>doc/doxygen-user-pdf.cfg
$(OTF2_V_DOXYGEN)$(DOXYGEN) doc/doxygen-user-pdf.cfg
$(AM_V_at)cd "$(USER_DOC_DIR)/pdf" && \
make $(OTF2_V_DEVNULL) && \
mv refman.pdf ../ && \
rm -f * && \
mv ../refman.pdf @PACKAGE@.pdf
else # i.e. ! HAVE_DOXYGEN_LATEX -------------------------------------
doxygen-user-pdf: doxygen-user
$(AM_V_at)echo "WARNING: pdflatex not available. Cannot generate doxygen pdf documentation." >&2
$(AM_V_at)if test -d "$(USER_DOC_DIR)/pdf"; then rm -rf "$(USER_DOC_DIR)/pdf"; fi
endif # HAVE_DOXYGEN_LATEX -------------------------------------------
sphinx-user-install:
if HAVE_PYTHON_SPHINX
sphinx-user-generate: sphinx-user sphinx-user-html-compress
sphinx-project-number: update-revision
$(AM_V_at)echo "version = \"@PACKAGE_VERSION@\"" > doc/sphinx_project_number.py
$(AM_V_at)echo "release = \"@PACKAGE_VERSION@ (revision `cat $(srcdir)/build-config/REVISION`)\"" >> doc/sphinx_project_number.py
CLEANFILES += doc/sphinx_project_number.py
sphinx-user: sphinx-project-number
$(AM_V_at)if test -f "build-backend/python_bindings_supported" || test -f "build-frontend/python_bindings_supported"; then \
OTF2_PYTHON_SPHINX_GENERATOR_RUN=yes PYTHONPATH="$$PYTHONPATH:$(abs_srcdir)/src/python:$$PWD/doc" \
make -C $(DOC_SRC_DIR)/python SPHINXBUILD=$(SPHINX) SPHINX_V=@AM_V@ SPHINX_DEFAULT_V=@AM_DEFAULT_V@ BUILDDIR=$$PWD/$(USER_DOC_DIR)/python html; \
else \
echo "WARNING: python bindings not available, cannot build otf2 python bindings documentation" >&2; \
fi
sphinx-user-html-compress:
$(AM_V_at)if test -d "$(USER_DOC_DIR)/python"; then \
cd "$(USER_DOC_DIR)"; tar czf python.tar.gz python; rm -rf python/; \
fi
else # i.e. ! HAVE_PYTHON_SPHINX
sphinx-user-generate:
@echo "WARNING: sphinx-build not available. Cannot generate python documentation." >&2
endif # HAVE_PYTHON_SPHINX -------------------------------------------
else # i.e. ! GIT_CONTROLLED -----------------------------------------
doxygen-user-pdf:
doxygen-user-install: sphinx-user-install
$(AM_V_at)if test -f "$(DOC_SRC_DIR)/html.tar.gz"; then \
$(MKDIR_P) $(DESTDIR)$(docdir); \
$(INSTALL_DATA) $(DOC_SRC_DIR)/html.tar.gz $(DESTDIR)$(docdir)/html.tar.gz; \
cd $(DESTDIR)$(docdir); \
tar xzf html.tar.gz; \
rm -f html.tar.gz; \
fi
$(AM_V_at)if test -d "$(DOC_SRC_DIR)"; then \
cd $(DOC_SRC_DIR); \
dirs="pdf tags"; \
cd -; \
for i in $$dirs; do \
if test -d "$(DOC_SRC_DIR)/$$i"; then \
$(MKDIR_P) $(DESTDIR)$(docdir)/$$i; \
cd $(DOC_SRC_DIR)/$$i; \
files=`find . -type f`; \
cd -; \
for j in $$files; do \
$(INSTALL_DATA) $(DOC_SRC_DIR)/$$i/$$j $(DESTDIR)$(docdir)/$$i/$$j; \
done; \
fi; \
done; \
fi
copy-revision-file-to-dist:
sphinx-user-generate:
sphinx-user-install:
$(AM_V_at)if test -f "$(DOC_SRC_DIR)/python.tar.gz"; then \
$(MKDIR_P) $(DESTDIR)$(docdir); \
$(INSTALL_DATA) $(DOC_SRC_DIR)/python.tar.gz $(DESTDIR)$(docdir)/python.tar.gz; \
cd $(DESTDIR)$(docdir); \
tar xzf python.tar.gz; \
rm -f python.tar.gz; \
fi
endif # GIT_CONTROLLED
##
##
###############################################################################
|
