gtk-doc.make 8.64 KB
Newer Older
1 2 3 4 5 6 7
# -*- mode: makefile -*-

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

if GTK_DOC_USE_LIBTOOL
8 9
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)
10
GTKDOC_RUN = $(LIBTOOL) --mode=execute
11
else
12 13
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)
14
GTKDOC_RUN =
15 16 17 18 19 20 21 22 23 24 25
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)

26
SETUP_FILES = \
27 28 29 30 31
	$(content_files)		\
	$(DOC_MAIN_SGML_FILE)		\
	$(DOC_MODULE)-sections.txt	\
	$(DOC_MODULE)-overrides.txt

32
EXTRA_DIST = 				\
33
	$(HTML_IMAGES)			\
34 35 36 37
	$(SETUP_FILES)

DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
	html-build.stamp pdf-build.stamp \
38
	sgml.stamp html.stamp pdf.stamp
39 40 41 42 43 44 45 46

SCANOBJ_FILES = 		 \
	$(DOC_MODULE).args 	 \
	$(DOC_MODULE).hierarchy  \
	$(DOC_MODULE).interfaces \
	$(DOC_MODULE).prerequisites \
	$(DOC_MODULE).signals

47 48 49 50 51 52
REPORT_FILES = \
	$(DOC_MODULE)-undocumented.txt \
	$(DOC_MODULE)-undeclared.txt \
	$(DOC_MODULE)-unused.txt

CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
53 54

if ENABLE_GTK_DOC
55 56 57 58 59 60 61 62 63 64 65 66
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

all-local: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
67 68 69 70
else
all-local:
endif

71
docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
72

73 74
$(REPORT_FILES): sgml-build.stamp

75 76
#### setup ####

Albert Astals Cid's avatar
Albert Astals Cid committed
77 78 79 80
GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_$(V))
GTK_DOC_V_SETUP_=$(GTK_DOC_V_SETUP_$(AM_DEFAULT_VERBOSITY))
GTK_DOC_V_SETUP_0=@echo "  DOC   Preparing build";

81
setup-build.stamp:
Albert Astals Cid's avatar
Albert Astals Cid committed
82
	-$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
83 84 85 86
	    files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \
	    if test "x$$files" != "x" ; then \
	        for file in $$files ; do \
	            test -f $(abs_srcdir)/$$file && \
Albert Astals Cid's avatar
Albert Astals Cid committed
87
	                cp -pu $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \
88 89
	        done; \
	    fi; \
90
	fi
Albert Astals Cid's avatar
Albert Astals Cid committed
91
	$(AM_V_at)touch setup-build.stamp
92 93


94 95
#### scan ####

Albert Astals Cid's avatar
Albert Astals Cid committed
96 97 98 99 100 101 102 103
GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_$(V))
GTK_DOC_V_SCAN_=$(GTK_DOC_V_SCAN_$(AM_DEFAULT_VERBOSITY))
GTK_DOC_V_SCAN_0=@echo "  DOC   Scanning header files";

GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_$(V))
GTK_DOC_V_INTROSPECT_=$(GTK_DOC_V_INTROSPECT_$(AM_DEFAULT_VERBOSITY))
GTK_DOC_V_INTROSPECT_0=@echo "  DOC   Introspecting gobjects";

104
scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
Albert Astals Cid's avatar
Albert Astals Cid committed
105
	$(GTK_DOC_V_SCAN)_source_dir='' ; \
106
	for i in $(DOC_SOURCE_DIR) ; do \
107
	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
108 109
	done ; \
	gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
Albert Astals Cid's avatar
Albert Astals Cid committed
110
	$(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
111 112 113 114 115 116 117 118 119
	    scanobj_options=""; \
	    gtkdoc-scangobj 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
	    if test "$(?)" = "0"; then \
	        if test "x$(V)" = "x1"; then \
	            scanobj_options="--verbose"; \
	        fi; \
	    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); \
120 121
	else \
	    for i in $(SCANOBJ_FILES) ; do \
122
	        test -f $$i || touch $$i ; \
123 124
	    done \
	fi
Albert Astals Cid's avatar
Albert Astals Cid committed
125
	$(AM_V_at)touch scan-build.stamp
126 127 128 129 130 131

$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
	@true

#### xml ####

Albert Astals Cid's avatar
Albert Astals Cid committed
132 133 134 135
GTK_DOC_V_XML=$(GTK_DOC_V_XML_$(V))
GTK_DOC_V_XML_=$(GTK_DOC_V_XML_$(AM_DEFAULT_VERBOSITY))
GTK_DOC_V_XML_0=@echo "  DOC   Building XML";

136
sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files)
Albert Astals Cid's avatar
Albert Astals Cid committed
137
	$(GTK_DOC_V_XML)_source_dir='' ; \
138
	for i in $(DOC_SOURCE_DIR) ; do \
139
	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
140 141
	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)
Albert Astals Cid's avatar
Albert Astals Cid committed
142
	$(AM_V_at)touch sgml-build.stamp
143 144 145 146 147 148

sgml.stamp: sgml-build.stamp
	@true

#### html ####

Albert Astals Cid's avatar
Albert Astals Cid committed
149 150 151 152 153 154 155 156
GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_$(V))
GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_$(AM_DEFAULT_VERBOSITY))
GTK_DOC_V_HTML_0=@echo "  DOC   Building HTML";

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

157
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
Albert Astals Cid's avatar
Albert Astals Cid committed
158 159
	$(GTK_DOC_V_HTML)rm -rf html && mkdir html && \
	mkhtml_options=""; \
160 161 162 163 164 165
	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
	if test "$(?)" = "0"; then \
	  if test "x$(V)" = "x1"; then \
	    mkhtml_options="$$mkhtml_options --verbose"; \
	  fi; \
	fi; \
166 167
	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
	if test "$(?)" = "0"; then \
168
	  mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
169
	fi; \
170 171 172 173 174 175 176 177 178 179
	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 \
	  if test -f $(abs_srcdir)/$$file ; then \
	    cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
	  fi; \
	  if test -f $(abs_builddir)/$$file ; then \
	    cp $(abs_builddir)/$$file $(abs_builddir)/html; \
	  fi; \
	done;
Albert Astals Cid's avatar
Albert Astals Cid committed
180 181
	$(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
182

183 184
#### pdf ####

Albert Astals Cid's avatar
Albert Astals Cid committed
185 186 187 188
GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_$(V))
GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_$(AM_DEFAULT_VERBOSITY))
GTK_DOC_V_PDF_0=@echo "  DOC   Building PDF";

189
pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
Albert Astals Cid's avatar
Albert Astals Cid committed
190 191
	$(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \
	mkpdf_options=""; \
192 193 194 195 196 197
	gtkdoc-mkpdf 2>&1 --help | grep  >/dev/null "\-\-verbose"; \
	if test "$(?)" = "0"; then \
	  if test "x$(V)" = "x1"; then \
	    mkpdf_options="$$mkpdf_options --verbose"; \
	  fi; \
	fi; \
198 199 200
	if test "x$(HTML_IMAGES)" != "x"; then \
	  for img in $(HTML_IMAGES); do \
	    part=`dirname $$img`; \
201
	    echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
202
	    if test $$? != 0; then \
203
	      mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
204 205 206
	    fi; \
	  done; \
	fi; \
207
	gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
Albert Astals Cid's avatar
Albert Astals Cid committed
208
	$(AM_V_at)touch pdf-build.stamp
209

210 211 212
##############

clean-local:
213 214
	@rm -f *~ *.bak
	@rm -rf .libs
215

216
distclean-local:
217
	@rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
218
	    $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
219
	@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
220 221
	    rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
	fi
222

Albert Astals Cid's avatar
Albert Astals Cid committed
223
maintainer-clean-local:
224
	@rm -rf xml html
225 226

install-data-local:
Albert Astals Cid's avatar
Albert Astals Cid committed
227
	@installfiles=`echo $(builddir)/html/*`; \
228 229
	if test "$$installfiles" = '$(builddir)/html/*'; \
	then echo 1>&2 'Nothing to install' ; \
230
	else \
231 232 233 234 235 236
	  if test -n "$(DOC_MODULE_VERSION)"; then \
	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	  else \
	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
	  fi; \
	  $(mkinstalldirs) $${installdir} ; \
237
	  for i in $$installfiles; do \
238
	    echo ' $(INSTALL_DATA) '$$i ; \
239
	    $(INSTALL_DATA) $$i $${installdir}; \
240
	  done; \
241 242 243 244 245
	  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}; \
246 247 248
	fi

uninstall-local:
249 250 251 252 253 254
	@if test -n "$(DOC_MODULE_VERSION)"; then \
	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	else \
	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
	fi; \
	rm -rf $${installdir}
255 256 257 258 259

#
# Require gtk-doc when making dist
#
if ENABLE_GTK_DOC
Albert Astals Cid's avatar
Albert Astals Cid committed
260
dist-check-gtkdoc: docs
261 262 263 264 265 266 267
else
dist-check-gtkdoc:
	@echo "*** gtk-doc must be installed and enabled in order to make dist"
	@false
endif

dist-hook: dist-check-gtkdoc dist-hook-local
268 269 270 271 272 273 274
	@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
275 276

.PHONY : dist-hook-local docs