gtk-doc.make 10.5 KB
Newer Older
Simon Josefsson's avatar
Simon Josefsson committed
1
# -*- mode: makefile -*-
Andreas Metzler's avatar
Andreas Metzler committed
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
#
# gtk-doc.make - make rules for gtk-doc
# Copyright (C) 2003 James Henstridge
#               2004-2007 Damon Chaplin
#               2007-2017 Stefan Sauer
#
# This program 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.
#
# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
Simon Josefsson's avatar
Simon Josefsson committed
20 21 22 23 24 25

####################################
# Everything below here is generic #
####################################

if GTK_DOC_USE_LIBTOOL
26 27
GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
Simon Josefsson's avatar
Simon Josefsson committed
28
GTKDOC_RUN = $(LIBTOOL) --mode=execute
Simon Josefsson's avatar
Simon Josefsson committed
29
else
30 31
GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
32
GTKDOC_RUN =
Simon Josefsson's avatar
Simon Josefsson committed
33 34 35 36 37 38 39 40 41 42 43
endif

# We set GPATH here; this gives us semantics for GNU make
# which are more like other make's VPATH, when it comes to
# whether a source that is a target of one rule is then
# searched for in VPATH/GPATH.
#
GPATH = $(srcdir)

TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)

44
SETUP_FILES = \
Simon Josefsson's avatar
Simon Josefsson committed
45
	$(content_files)		\
Andreas Metzler's avatar
Andreas Metzler committed
46
	$(expand_content_files)		\
Simon Josefsson's avatar
Simon Josefsson committed
47 48 49 50
	$(DOC_MAIN_SGML_FILE)		\
	$(DOC_MODULE)-sections.txt	\
	$(DOC_MODULE)-overrides.txt

51 52 53 54
EXTRA_DIST = 				\
	$(HTML_IMAGES)			\
	$(SETUP_FILES)

Andreas Metzler's avatar
Andreas Metzler committed
55
DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
56
	html-build.stamp pdf-build.stamp \
Andreas Metzler's avatar
Andreas Metzler committed
57
	sgml.stamp html.stamp pdf.stamp
Simon Josefsson's avatar
Simon Josefsson committed
58

59 60
SCANOBJ_FILES = 		 \
	$(DOC_MODULE).args 	 \
Simon Josefsson's avatar
Simon Josefsson committed
61 62 63 64 65
	$(DOC_MODULE).hierarchy  \
	$(DOC_MODULE).interfaces \
	$(DOC_MODULE).prerequisites \
	$(DOC_MODULE).signals

Simon Josefsson's avatar
Simon Josefsson committed
66 67 68 69 70
REPORT_FILES = \
	$(DOC_MODULE)-undocumented.txt \
	$(DOC_MODULE)-undeclared.txt \
	$(DOC_MODULE)-unused.txt

Andreas Metzler's avatar
Andreas Metzler committed
71 72 73 74 75 76
gtkdoc-check.test: Makefile
	$(AM_V_GEN)echo "#!/bin/sh -e" > $@; \
		echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \
		chmod +x $@

CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) gtkdoc-check.test
Simon Josefsson's avatar
Simon Josefsson committed
77

78 79 80 81 82 83 84 85 86 87 88
if GTK_DOC_BUILD_HTML
HTML_BUILD_STAMP=html-build.stamp
else
HTML_BUILD_STAMP=
endif
if GTK_DOC_BUILD_PDF
PDF_BUILD_STAMP=pdf-build.stamp
else
PDF_BUILD_STAMP=
endif

Andreas Metzler's avatar
Andreas Metzler committed
89 90 91 92 93
all-gtk-doc: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
.PHONY: all-gtk-doc

if ENABLE_GTK_DOC
all-local: all-gtk-doc
Simon Josefsson's avatar
Simon Josefsson committed
94 95
endif

96
docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
Simon Josefsson's avatar
Simon Josefsson committed
97 98

$(REPORT_FILES): sgml-build.stamp
Simon Josefsson's avatar
Simon Josefsson committed
99

100 101
#### setup ####

Andreas Metzler's avatar
Andreas Metzler committed
102 103 104 105
GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_@AM_V@)
GTK_DOC_V_SETUP_=$(GTK_DOC_V_SETUP_@AM_DEFAULT_V@)
GTK_DOC_V_SETUP_0=@echo "  DOC   Preparing build";

106
setup-build.stamp:
Andreas Metzler's avatar
Andreas Metzler committed
107 108 109 110 111 112 113 114 115 116
	-$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
	  files=`echo $(SETUP_FILES) $(DOC_MODULE).types`; \
	  if test "x$$files" != "x" ; then \
	    for file in $$files ; do \
	      destdir=`dirname $(abs_builddir)/$$file`; \
	      test -d "$$destdir" || mkdir -p "$$destdir"; \
	      test -f $(abs_srcdir)/$$file && \
	        cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \
	    done; \
	  fi; \
117
	fi
Andreas Metzler's avatar
Andreas Metzler committed
118
	$(AM_V_at)touch setup-build.stamp
119

Simon Josefsson's avatar
Simon Josefsson committed
120 121
#### scan ####

Andreas Metzler's avatar
Andreas Metzler committed
122 123 124 125 126 127 128 129 130 131
GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_@AM_V@)
GTK_DOC_V_SCAN_=$(GTK_DOC_V_SCAN_@AM_DEFAULT_V@)
GTK_DOC_V_SCAN_0=@echo "  DOC   Scanning header files";

GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_@AM_V@)
GTK_DOC_V_INTROSPECT_=$(GTK_DOC_V_INTROSPECT_@AM_DEFAULT_V@)
GTK_DOC_V_INTROSPECT_0=@echo "  DOC   Introspecting gobjects";

scan-build.stamp: setup-build.stamp $(HFILE_GLOB) $(CFILE_GLOB)
	$(GTK_DOC_V_SCAN)_source_dir='' ; \
132
	for i in $(DOC_SOURCE_DIR) ; do \
Andreas Metzler's avatar
Andreas Metzler committed
133
	  _source_dir="$${_source_dir} --source-dir=$$i" ; \
134 135
	done ; \
	gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
Andreas Metzler's avatar
Andreas Metzler committed
136 137 138 139 140 141
	$(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
	  scanobj_options=""; \
	  gtkdoc-scangobj 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
	  if test "$$?" = "0"; then \
	    if test "x$(V)" = "x1"; then \
	      scanobj_options="--verbose"; \
142
	    fi; \
Andreas Metzler's avatar
Andreas Metzler committed
143 144 145
	  fi; \
	  CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \
	  gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
Simon Josefsson's avatar
Simon Josefsson committed
146
	else \
Andreas Metzler's avatar
Andreas Metzler committed
147 148 149
	  for i in $(SCANOBJ_FILES) ; do \
	    test -f $$i || touch $$i ; \
	  done \
Simon Josefsson's avatar
Simon Josefsson committed
150
	fi
Andreas Metzler's avatar
Andreas Metzler committed
151
	$(AM_V_at)touch scan-build.stamp
Simon Josefsson's avatar
Simon Josefsson committed
152

Simon Josefsson's avatar
Simon Josefsson committed
153
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
Simon Josefsson's avatar
Simon Josefsson committed
154 155 156 157
	@true

#### xml ####

Andreas Metzler's avatar
Andreas Metzler committed
158 159 160 161 162 163
GTK_DOC_V_XML=$(GTK_DOC_V_XML_@AM_V@)
GTK_DOC_V_XML_=$(GTK_DOC_V_XML_@AM_DEFAULT_V@)
GTK_DOC_V_XML_0=@echo "  DOC   Building XML";

sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files) xml/gtkdocentities.ent
	$(GTK_DOC_V_XML)_source_dir='' ; \
164
	for i in $(DOC_SOURCE_DIR) ; do \
Andreas Metzler's avatar
Andreas Metzler committed
165
	  _source_dir="$${_source_dir} --source-dir=$$i" ; \
166 167
	done ; \
	gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS)
Andreas Metzler's avatar
Andreas Metzler committed
168
	$(AM_V_at)touch sgml-build.stamp
Simon Josefsson's avatar
Simon Josefsson committed
169 170 171 172

sgml.stamp: sgml-build.stamp
	@true

Andreas Metzler's avatar
Andreas Metzler committed
173 174 175 176 177 178 179 180 181 182 183 184 185 186
$(DOC_MAIN_SGML_FILE): sgml-build.stamp
	@true

xml/gtkdocentities.ent: Makefile
	$(GTK_DOC_V_XML)$(MKDIR_P) $(@D) && ( \
		echo "<!ENTITY package \"$(PACKAGE)\">"; \
		echo "<!ENTITY package_bugreport \"$(PACKAGE_BUGREPORT)\">"; \
		echo "<!ENTITY package_name \"$(PACKAGE_NAME)\">"; \
		echo "<!ENTITY package_string \"$(PACKAGE_STRING)\">"; \
		echo "<!ENTITY package_tarname \"$(PACKAGE_TARNAME)\">"; \
		echo "<!ENTITY package_url \"$(PACKAGE_URL)\">"; \
		echo "<!ENTITY package_version \"$(PACKAGE_VERSION)\">"; \
	) > $@

Simon Josefsson's avatar
Simon Josefsson committed
187 188
#### html ####

Andreas Metzler's avatar
Andreas Metzler committed
189 190 191 192 193 194 195 196 197 198 199
GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_@AM_V@)
GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_@AM_DEFAULT_V@)
GTK_DOC_V_HTML_0=@echo "  DOC   Building HTML";

GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_@AM_V@)
GTK_DOC_V_XREF_=$(GTK_DOC_V_XREF_@AM_DEFAULT_V@)
GTK_DOC_V_XREF_0=@echo "  DOC   Fixing cross-references";

html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
	$(GTK_DOC_V_HTML)rm -rf html && mkdir html && \
	mkhtml_options=""; \
200
	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
Andreas Metzler's avatar
Andreas Metzler committed
201
	if test "$$?" = "0"; then \
202 203 204 205
	  if test "x$(V)" = "x1"; then \
	    mkhtml_options="$$mkhtml_options --verbose"; \
	  fi; \
	fi; \
Simon Josefsson's avatar
Simon Josefsson committed
206
	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
Andreas Metzler's avatar
Andreas Metzler committed
207
	if test "$$?" = "0"; then \
208
	  mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
209
	fi; \
210 211 212
	cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
	-@test "x$(HTML_IMAGES)" = "x" || \
	for file in $(HTML_IMAGES) ; do \
Andreas Metzler's avatar
Andreas Metzler committed
213 214 215
	  test -f $(abs_srcdir)/$$file && cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
	  test -f $(abs_builddir)/$$file && cp $(abs_builddir)/$$file $(abs_builddir)/html; \
	  test -f $$file && cp $$file $(abs_builddir)/html; \
216
	done;
Andreas Metzler's avatar
Andreas Metzler committed
217 218
	$(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
	$(AM_V_at)touch html-build.stamp
Simon Josefsson's avatar
Simon Josefsson committed
219

220 221
#### pdf ####

Andreas Metzler's avatar
Andreas Metzler committed
222 223 224 225 226 227 228
GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_@AM_V@)
GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_@AM_DEFAULT_V@)
GTK_DOC_V_PDF_0=@echo "  DOC   Building PDF";

pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
	$(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \
	mkpdf_options=""; \
229
	gtkdoc-mkpdf 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
Andreas Metzler's avatar
Andreas Metzler committed
230
	if test "$$?" = "0"; then \
231 232 233 234
	  if test "x$(V)" = "x1"; then \
	    mkpdf_options="$$mkpdf_options --verbose"; \
	  fi; \
	fi; \
235 236 237
	if test "x$(HTML_IMAGES)" != "x"; then \
	  for img in $(HTML_IMAGES); do \
	    part=`dirname $$img`; \
238
	    echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
239
	    if test $$? != 0; then \
240
	      mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
241 242 243
	    fi; \
	  done; \
	fi; \
244
	gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
Andreas Metzler's avatar
Andreas Metzler committed
245
	$(AM_V_at)touch pdf-build.stamp
246

Simon Josefsson's avatar
Simon Josefsson committed
247 248 249
##############

clean-local:
250 251
	@rm -f *~ *.bak
	@rm -rf .libs
Andreas Metzler's avatar
Andreas Metzler committed
252 253 254 255 256 257
	@if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-types" ; then \
	  rm -f $(DOC_MODULE).types; \
	fi
	@if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-sections" ; then \
	  rm -f $(DOC_MODULE)-sections.txt; \
	fi
Simon Josefsson's avatar
Simon Josefsson committed
258

Simon Josefsson's avatar
Simon Josefsson committed
259
distclean-local:
260 261 262
	@rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
	    $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
	@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
Andreas Metzler's avatar
Andreas Metzler committed
263
	    rm -f $(SETUP_FILES) $(DOC_MODULE).types; \
264
	fi
Simon Josefsson's avatar
Simon Josefsson committed
265

Andreas Metzler's avatar
Andreas Metzler committed
266
maintainer-clean-local:
267
	@rm -rf xml html
Simon Josefsson's avatar
Simon Josefsson committed
268 269

install-data-local:
270 271 272
	@installfiles=`echo $(builddir)/html/*`; \
	if test "$$installfiles" = '$(builddir)/html/*'; \
	then echo 1>&2 'Nothing to install' ; \
Simon Josefsson's avatar
Simon Josefsson committed
273
	else \
274 275 276 277 278 279
	  if test -n "$(DOC_MODULE_VERSION)"; then \
	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	  else \
	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
	  fi; \
	  $(mkinstalldirs) $${installdir} ; \
Simon Josefsson's avatar
Simon Josefsson committed
280
	  for i in $$installfiles; do \
281
	    echo ' $(INSTALL_DATA) '$$i ; \
282
	    $(INSTALL_DATA) $$i $${installdir}; \
Simon Josefsson's avatar
Simon Josefsson committed
283
	  done; \
284 285 286 287 288
	  if test -n "$(DOC_MODULE_VERSION)"; then \
	    mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
	  fi; \
	  $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
Simon Josefsson's avatar
Simon Josefsson committed
289 290 291
	fi

uninstall-local:
292 293 294 295 296 297
	@if test -n "$(DOC_MODULE_VERSION)"; then \
	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	else \
	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
	fi; \
	rm -rf $${installdir}
Simon Josefsson's avatar
Simon Josefsson committed
298 299 300 301

#
# Require gtk-doc when making dist
#
Andreas Metzler's avatar
Andreas Metzler committed
302 303
if HAVE_GTK_DOC
dist-check-gtkdoc: docs
Simon Josefsson's avatar
Simon Josefsson committed
304 305
else
dist-check-gtkdoc:
Andreas Metzler's avatar
Andreas Metzler committed
306 307 308
	@echo "*** gtk-doc is needed to run 'make dist'.         ***"
	@echo "*** gtk-doc was not found when 'configure' ran.   ***"
	@echo "*** please install gtk-doc and rerun 'configure'. ***"
Simon Josefsson's avatar
Simon Josefsson committed
309 310 311
	@false
endif

Andreas Metzler's avatar
Andreas Metzler committed
312
dist-hook: dist-check-gtkdoc all-gtk-doc dist-hook-local
313 314 315 316 317 318 319
	@mkdir $(distdir)/html
	@cp ./html/* $(distdir)/html
	@-cp ./$(DOC_MODULE).pdf $(distdir)/
	@-cp ./$(DOC_MODULE).types $(distdir)/
	@-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
	@cd $(distdir) && rm -f $(DISTCLEANFILES)
	@$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
Simon Josefsson's avatar
Simon Josefsson committed
320

Simon Josefsson's avatar
Simon Josefsson committed
321
.PHONY : dist-hook-local docs