gtk-doc.make 7.68 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
	$(SETUP_FILES)

36 37
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 ####

77
setup-build.stamp:
78
	-@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
79 80 81 82 83 84 85 86
	    echo '  DOC   Preparing build'; \
	    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 && \
	                cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \
	        done; \
	    fi; \
87
	fi
88
	@touch setup-build.stamp
89 90


91 92 93
#### scan ####

scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
94
	@echo '  DOC   Scanning header files'
95 96
	@_source_dir='' ; \
	for i in $(DOC_SOURCE_DIR) ; do \
97
	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
98 99 100
	done ; \
	gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
	@if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
101 102 103 104 105 106 107 108 109 110
	    echo "  DOC   Introspecting gobjects"; \
	    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); \
111 112
	else \
	    for i in $(SCANOBJ_FILES) ; do \
113
	        test -f $$i || touch $$i ; \
114 115
	    done \
	fi
116
	@touch scan-build.stamp
117

118
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
119 120 121 122
	@true

#### xml ####

123 124
sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files)
	@echo '  DOC   Building XML'
125 126
	@_source_dir='' ; \
	for i in $(DOC_SOURCE_DIR) ; do \
127
	    _source_dir="$${_source_dir} --source-dir=$$i" ; \
128
	done ; \
129
	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)
130
	@touch sgml-build.stamp
131 132 133 134 135 136 137

sgml.stamp: sgml-build.stamp
	@true

#### html ####

html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
138
	@echo '  DOC   Building HTML'
139 140
	@rm -rf html
	@mkdir html
141
	@mkhtml_options=""; \
142 143 144 145 146 147
	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; \
148 149
	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
	if test "$(?)" = "0"; then \
150
	  mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
151
	fi; \
152
	cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
153 154 155 156 157 158 159 160 161
	-@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;
162
	@echo '  DOC   Fixing cross-references'
163
	@gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
164 165 166 167 168
	@touch html-build.stamp

#### pdf ####

pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
169 170 171 172 173 174 175 176 177
	@echo '  DOC   Building PDF'
	@rm -f $(DOC_MODULE).pdf
	@mkpdf_options=""; \
	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; \
178 179 180
	if test "x$(HTML_IMAGES)" != "x"; then \
	  for img in $(HTML_IMAGES); do \
	    part=`dirname $$img`; \
181
	    echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
182
	    if test $$? != 0; then \
183
	      mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
184 185 186
	    fi; \
	  done; \
	fi; \
187
	gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
188
	@touch pdf-build.stamp
189 190 191 192

##############

clean-local:
193 194
	@rm -f *~ *.bak
	@rm -rf .libs
195

196
distclean-local:
197
	@rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
198
	    $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
199
	@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
200
	    rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \
201
	fi
202

203
maintainer-clean-local: clean
204
	@rm -rf xml html
205 206

install-data-local:
207
	@installfiles=`echo $(builddir)/html/*`; \
208 209
	if test "$$installfiles" = '$(builddir)/html/*'; \
	then echo 1>&2 'Nothing to install' ; \
210
	else \
211 212 213 214 215 216
	  if test -n "$(DOC_MODULE_VERSION)"; then \
	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	  else \
	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
	  fi; \
	  $(mkinstalldirs) $${installdir} ; \
217
	  for i in $$installfiles; do \
218
	    echo ' $(INSTALL_DATA) '$$i ; \
219
	    $(INSTALL_DATA) $$i $${installdir}; \
220
	  done; \
221 222 223 224
	  if test -n "$(DOC_MODULE_VERSION)"; then \
	    mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
	  fi; \
225
	  $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
226 227 228
	fi

uninstall-local:
229
	@if test -n "$(DOC_MODULE_VERSION)"; then \
230 231 232 233 234
	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
	else \
	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
	fi; \
	rm -rf $${installdir}
235 236 237 238 239 240 241 242 243 244 245 246 247

#
# Require gtk-doc when making dist
#
if ENABLE_GTK_DOC
dist-check-gtkdoc:
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
248 249 250 251 252 253 254
	@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
255

256
.PHONY : dist-hook-local docs