1# -*- mode: makefile -*- 2# 3# gtk-doc.make - make rules for gtk-doc 4# Copyright (C) 2003 James Henstridge 5# 2004-2007 Damon Chaplin 6# 2007-2017 Stefan Sauer 7# 8# This program is free software: you can redistribute it and/or modify 9# it under the terms of the GNU General Public License as published by 10# the Free Software Foundation, either version 3 of the License, or 11# (at your option) any later version. 12# 13# This program is distributed in the hope that it will be useful, 14# but WITHOUT ANY WARRANTY; without even the implied warranty of 15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16# GNU General Public License for more details. 17# 18# You should have received a copy of the GNU General Public License 19# along with this program. If not, see <http://www.gnu.org/licenses/>. 20 21#################################### 22# Everything below here is generic # 23#################################### 24 25if GTK_DOC_USE_LIBTOOL 26GTKDOC_CC = $(LIBTOOL) --tag=CC --mode=compile $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) 27GTKDOC_LD = $(LIBTOOL) --tag=CC --mode=link $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) 28GTKDOC_RUN = $(LIBTOOL) --mode=execute 29else 30GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) 31GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS) 32GTKDOC_RUN = 33endif 34 35# We set GPATH here; this gives us semantics for GNU make 36# which are more like other make's VPATH, when it comes to 37# whether a source that is a target of one rule is then 38# searched for in VPATH/GPATH. 39# 40GPATH = $(srcdir) 41 42TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) 43 44SETUP_FILES = \ 45 $(content_files) \ 46 $(expand_content_files) \ 47 $(DOC_MAIN_SGML_FILE) \ 48 $(DOC_MODULE)-sections.txt \ 49 $(DOC_MODULE)-overrides.txt 50 51EXTRA_DIST = \ 52 $(HTML_IMAGES) \ 53 $(SETUP_FILES) 54 55DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \ 56 html-build.stamp pdf-build.stamp \ 57 sgml.stamp html.stamp pdf.stamp 58 59SCANOBJ_FILES = \ 60 $(DOC_MODULE).args \ 61 $(DOC_MODULE).hierarchy \ 62 $(DOC_MODULE).interfaces \ 63 $(DOC_MODULE).prerequisites \ 64 $(DOC_MODULE).signals 65 66REPORT_FILES = \ 67 $(DOC_MODULE)-undocumented.txt \ 68 $(DOC_MODULE)-undeclared.txt \ 69 $(DOC_MODULE)-unused.txt 70 71gtkdoc-check.test: Makefile 72 $(AM_V_GEN)echo "#!/bin/sh -e" > $@; \ 73 echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \ 74 chmod +x $@ 75 76CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) gtkdoc-check.test 77 78if GTK_DOC_BUILD_HTML 79HTML_BUILD_STAMP=html-build.stamp 80else 81HTML_BUILD_STAMP= 82endif 83if GTK_DOC_BUILD_PDF 84PDF_BUILD_STAMP=pdf-build.stamp 85else 86PDF_BUILD_STAMP= 87endif 88 89all-gtk-doc: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) 90.PHONY: all-gtk-doc 91 92if ENABLE_GTK_DOC 93all-local: all-gtk-doc 94endif 95 96docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP) 97 98$(REPORT_FILES): sgml-build.stamp 99 100#### setup #### 101 102GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_$(V)) 103GTK_DOC_V_SETUP_=$(GTK_DOC_V_SETUP_$(AM_DEFAULT_VERBOSITY)) 104GTK_DOC_V_SETUP_0=@echo " DOC Preparing build"; 105 106setup-build.stamp: 107 -$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ 108 files=`echo $(SETUP_FILES) $(DOC_MODULE).types`; \ 109 if test "x$$files" != "x" ; then \ 110 for file in $$files ; do \ 111 destdir=`dirname $(abs_builddir)/$$file`; \ 112 test -d "$$destdir" || mkdir -p "$$destdir"; \ 113 test -f $(abs_srcdir)/$$file && \ 114 cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \ 115 done; \ 116 fi; \ 117 fi 118 $(AM_V_at)touch setup-build.stamp 119 120 121#### scan #### 122 123GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_$(V)) 124GTK_DOC_V_SCAN_=$(GTK_DOC_V_SCAN_$(AM_DEFAULT_VERBOSITY)) 125GTK_DOC_V_SCAN_0=@echo " DOC Scanning header files"; 126 127GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_$(V)) 128GTK_DOC_V_INTROSPECT_=$(GTK_DOC_V_INTROSPECT_$(AM_DEFAULT_VERBOSITY)) 129GTK_DOC_V_INTROSPECT_0=@echo " DOC Introspecting gobjects"; 130 131scan-build.stamp: setup-build.stamp $(HFILE_GLOB) $(CFILE_GLOB) 132 $(GTK_DOC_V_SCAN)_source_dir='' ; \ 133 for i in $(DOC_SOURCE_DIR) ; do \ 134 _source_dir="$${_source_dir} --source-dir=$$i" ; \ 135 done ; \ 136 gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) 137 $(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ 138 scanobj_options=""; \ 139 gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \ 140 if test "$$?" = "0"; then \ 141 if test "x$(V)" = "x1"; then \ 142 scanobj_options="--verbose"; \ 143 fi; \ 144 fi; \ 145 CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" \ 146 gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \ 147 else \ 148 for i in $(SCANOBJ_FILES) ; do \ 149 test -f $$i || touch $$i ; \ 150 done \ 151 fi 152 $(AM_V_at)touch scan-build.stamp 153 154$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp 155 @true 156 157#### xml #### 158 159GTK_DOC_V_XML=$(GTK_DOC_V_XML_$(V)) 160GTK_DOC_V_XML_=$(GTK_DOC_V_XML_$(AM_DEFAULT_VERBOSITY)) 161GTK_DOC_V_XML_0=@echo " DOC Building XML"; 162 163sgml-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 164 $(GTK_DOC_V_XML)_source_dir='' ; \ 165 for i in $(DOC_SOURCE_DIR) ; do \ 166 _source_dir="$${_source_dir} --source-dir=$$i" ; \ 167 done ; \ 168 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) 169 $(AM_V_at)touch sgml-build.stamp 170 171sgml.stamp: sgml-build.stamp 172 @true 173 174xml/gtkdocentities.ent: Makefile 175 $(GTK_DOC_V_XML)$(MKDIR_P) $(@D) && ( \ 176 echo "<!ENTITY package \"$(PACKAGE)\">"; \ 177 echo "<!ENTITY package_bugreport \"$(PACKAGE_BUGREPORT)\">"; \ 178 echo "<!ENTITY package_name \"$(PACKAGE_NAME)\">"; \ 179 echo "<!ENTITY package_string \"$(PACKAGE_STRING)\">"; \ 180 echo "<!ENTITY package_tarname \"$(PACKAGE_TARNAME)\">"; \ 181 echo "<!ENTITY package_url \"$(PACKAGE_URL)\">"; \ 182 echo "<!ENTITY package_version \"$(PACKAGE_VERSION)\">"; \ 183 ) > $@ 184 185#### html #### 186 187GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_$(V)) 188GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_$(AM_DEFAULT_VERBOSITY)) 189GTK_DOC_V_HTML_0=@echo " DOC Building HTML"; 190 191GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_$(V)) 192GTK_DOC_V_XREF_=$(GTK_DOC_V_XREF_$(AM_DEFAULT_VERBOSITY)) 193GTK_DOC_V_XREF_0=@echo " DOC Fixing cross-references"; 194 195html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files) 196 $(GTK_DOC_V_HTML)rm -rf libgsequencer-html && mkdir libgsequencer-html && \ 197 mkhtml_options=""; \ 198 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \ 199 if test "$$?" = "0"; then \ 200 if test "x$(V)" = "x1"; then \ 201 mkhtml_options="$$mkhtml_options --verbose"; \ 202 fi; \ 203 fi; \ 204 gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ 205 if test "$$?" = "0"; then \ 206 mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \ 207 fi; \ 208 cd libgsequencer-html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) 209 -@test "x$(HTML_IMAGES)" = "x" || \ 210 for file in $(HTML_IMAGES) ; do \ 211 if test -f $(abs_srcdir)/$$file ; then \ 212 cp $(abs_srcdir)/$$file $(abs_builddir)/libgsequencer-html; \ 213 fi; \ 214 if test -f $(abs_builddir)/$$file ; then \ 215 cp $(abs_builddir)/$$file $(abs_builddir)/libgsequencer-html; \ 216 fi; \ 217 test -f $$file && cp $$file $(abs_builddir)/libgsequencer-html; \ 218 done; 219 $(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=libgsequencer-html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) 220 $(AM_V_at)touch html-build.stamp 221 222#### pdf #### 223 224GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_$(V)) 225GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_$(AM_DEFAULT_VERBOSITY)) 226GTK_DOC_V_PDF_0=@echo " DOC Building PDF"; 227 228pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files) 229 $(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \ 230 mkpdf_options=""; \ 231 gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \ 232 if test "$$?" = "0"; then \ 233 if test "x$(V)" = "x1"; then \ 234 mkpdf_options="$$mkpdf_options --verbose"; \ 235 fi; \ 236 fi; \ 237 if test "x$(HTML_IMAGES)" != "x"; then \ 238 for img in $(HTML_IMAGES); do \ 239 part=`dirname $$img`; \ 240 echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \ 241 if test $$? != 0; then \ 242 mkpdf_options="$$mkpdf_options --imgdir=$$part"; \ 243 fi; \ 244 done; \ 245 fi; \ 246 gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) 247 $(AM_V_at)touch pdf-build.stamp 248 249############## 250 251clean-local: 252 @rm -f *~ *.bak 253 @rm -rf .libs 254 @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-types" ; then \ 255 rm -f $(DOC_MODULE).types; \ 256 fi 257 @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-sections" ; then \ 258 rm -f $(DOC_MODULE)-sections.txt; \ 259 fi 260 261distclean-local: 262 @rm -rf xml libgsequencer-html $(REPORT_FILES) $(DOC_MODULE).pdf \ 263 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt 264 @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ 265 rm -f $(SETUP_FILES) $(DOC_MODULE).types; \ 266 fi 267 268maintainer-clean-local: 269 @rm -rf xml libgsequencer-html 270 271install-data-local: 272 @installfiles=`echo $(builddir)/libgsequencer-html/*`; \ 273 if test "$$installfiles" = '$(builddir)/libgsequencer-html/*'; \ 274 then echo 1>&2 'Nothing to install' ; \ 275 else \ 276 if test -n "$(DOC_MODULE_VERSION)"; then \ 277 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ 278 else \ 279 installdir="$(DESTDIR)$(TARGET_DIR)"; \ 280 fi; \ 281 $(mkinstalldirs) $${installdir} ; \ 282 for i in $$installfiles; do \ 283 echo ' $(INSTALL_DATA) '$$i ; \ 284 $(INSTALL_DATA) $$i $${installdir}; \ 285 done; \ 286 if test -n "$(DOC_MODULE_VERSION)"; then \ 287 mv -f $${installdir}/$(DOC_MODULE).devhelp2 \ 288 $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \ 289 fi; \ 290 $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \ 291 fi 292 293uninstall-local: 294 @if test -n "$(DOC_MODULE_VERSION)"; then \ 295 installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \ 296 else \ 297 installdir="$(DESTDIR)$(TARGET_DIR)"; \ 298 fi; \ 299 rm -rf $${installdir} 300 301# 302# Require gtk-doc when making dist 303# 304if HAVE_GTK_DOC 305dist-check-gtkdoc: docs 306else 307dist-check-gtkdoc: 308 @echo "*** gtk-doc is needed to run 'make dist'. ***" 309 @echo "*** gtk-doc was not found when 'configure' ran. ***" 310 @echo "*** please install gtk-doc and rerun 'configure'. ***" 311 @false 312endif 313 314dist-hook: dist-check-gtkdoc all-gtk-doc dist-hook-local 315 @mkdir $(distdir)/libgsequencer-html 316 @cp ./libgsequencer-html/* $(distdir)/libgsequencer-html 317 @-cp ./$(DOC_MODULE).pdf $(distdir)/ 318 @-cp ./$(DOC_MODULE).types $(distdir)/ 319 @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/ 320 @cd $(distdir) && rm -f $(DISTCLEANFILES) 321 @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/libgsequencer-html 322 323.PHONY : dist-hook-local docs 324