~agateau/libdbusmenu/fix-gtk3-warnings

107.1.1 by Ken VanDine
Build gtk-doc (LP: #422087)
1
# -*- mode: makefile -*-
2
3
####################################
4
# Everything below here is generic #
5
####################################
6
7
if GTK_DOC_USE_LIBTOOL
8
GTKDOC_CC = $(LIBTOOL) --mode=compile $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
9
GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
10
GTKDOC_RUN = $(LIBTOOL) --mode=execute
11
else
12
GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
13
GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
14
GTKDOC_RUN = sh -c
15
endif
16
17
# We set GPATH here; this gives us semantics for GNU make
18
# which are more like other make's VPATH, when it comes to
19
# whether a source that is a target of one rule is then
20
# searched for in VPATH/GPATH.
21
#
22
GPATH = $(srcdir)
23
24
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
25
26
EXTRA_DIST = 				\
27
	$(content_files)		\
28
	$(HTML_IMAGES)			\
29
	$(DOC_MAIN_SGML_FILE)
30
31
DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
32
	   $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
33
34
SCANOBJ_FILES = 		 \
35
	$(DOC_MODULE).args 	 \
36
	$(DOC_MODULE).hierarchy  \
37
	$(DOC_MODULE).interfaces \
38
	$(DOC_MODULE).prerequisites \
39
	$(DOC_MODULE).signals
40
41
REPORT_FILES = \
42
	$(DOC_MODULE)-undocumented.txt \
43
	$(DOC_MODULE)-undeclared.txt \
44
	$(DOC_MODULE)-unused.txt
45
46
CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS)
47
48
if ENABLE_GTK_DOC
49
all-local: html-build.stamp
50
else
51
all-local:
52
endif
53
54
docs: html-build.stamp
55
56
$(REPORT_FILES): sgml-build.stamp
57
58
#### scan ####
59
60
scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
61
	@echo 'gtk-doc: Scanning header files'
62
	@-chmod -R u+w $(srcdir)
63
	cd $(srcdir) && \
64
	  gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
65
	if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
66
	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
67
	else \
68
	    cd $(srcdir) ; \
69
	    for i in $(SCANOBJ_FILES) ; do \
70
               test -f $$i || touch $$i ; \
71
	    done \
72
	fi
73
	touch scan-build.stamp
74
75
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
76
	@true
77
78
#### templates ####
79
80
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
81
	@echo 'gtk-doc: Rebuilding template files'
82
	@-chmod -R u+w $(srcdir)
83
	cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
84
	touch tmpl-build.stamp
85
86
tmpl.stamp: tmpl-build.stamp
87
	@true
88
89
tmpl/*.sgml:
90
	@true
91
92
93
#### xml ####
94
95
sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
96
	@echo 'gtk-doc: Building XML'
97
	@-chmod -R u+w $(srcdir)
98
	cd $(srcdir) && \
99
	gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
100
	touch sgml-build.stamp
101
102
sgml.stamp: sgml-build.stamp
103
	@true
104
105
#### html ####
106
107
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
108
	@echo 'gtk-doc: Building HTML'
109
	@-chmod -R u+w $(srcdir)
110
	rm -rf $(srcdir)/html
111
	mkdir $(srcdir)/html
112
	mkhtml_options=""; \
113
	gtkdoc-mkhtml 2>&1 --help | grep  >/dev/null "\-\-path"; \
114
	if test "$(?)" = "0"; then \
115
	  mkhtml_options=--path="$(srcdir)"; \
116
	fi
117
	cd $(srcdir)/html && gtkdoc-mkhtml $(mkhtml_options) $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
118
	test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
119
	@echo 'gtk-doc: Fixing cross-references'
120
	cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
121
	touch html-build.stamp
122
123
##############
124
125
clean-local:
126
	rm -f *~ *.bak
127
	rm -rf .libs
128
129
distclean-local:
130
	cd $(srcdir) && \
131
	  rm -rf xml $(REPORT_FILES) \
132
	         $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
133
134
maintainer-clean-local: clean
135
	cd $(srcdir) && rm -rf xml html
136
137
install-data-local:
138
	installfiles=`echo $(srcdir)/html/*`; \
139
	if test "$$installfiles" = '$(srcdir)/html/*'; \
140
	then echo '-- Nothing to install' ; \
141
	else \
142
	  if test -n "$(DOC_MODULE_VERSION)"; then \
143
	    installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
144
	  else \
145
	    installdir="$(DESTDIR)$(TARGET_DIR)"; \
146
	  fi; \
147
	  $(mkinstalldirs) $${installdir} ; \
148
	  for i in $$installfiles; do \
149
	    echo '-- Installing '$$i ; \
150
	    $(INSTALL_DATA) $$i $${installdir}; \
151
	  done; \
152
	  if test -n "$(DOC_MODULE_VERSION)"; then \
153
	    mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
154
	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
155
	    mv -f $${installdir}/$(DOC_MODULE).devhelp \
156
	      $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp; \
157
	  fi; \
158
	  ! which gtkdoc-rebase >/dev/null 2>&1 || \
159
	    gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir} ; \
160
	fi
161
162
uninstall-local:
163
	if test -n "$(DOC_MODULE_VERSION)"; then \
164
	  installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
165
	else \
166
	  installdir="$(DESTDIR)$(TARGET_DIR)"; \
167
	fi; \
168
	rm -rf $${installdir}
169
170
#
171
# Require gtk-doc when making dist
172
#
173
if ENABLE_GTK_DOC
174
dist-check-gtkdoc:
175
else
176
dist-check-gtkdoc:
177
	@echo "*** gtk-doc must be installed and enabled in order to make dist"
178
	@false
179
endif
180
181
dist-hook: dist-check-gtkdoc dist-hook-local
182
	mkdir $(distdir)/tmpl
183
	mkdir $(distdir)/xml
184
	mkdir $(distdir)/html
185
	-cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
186
	-cp $(srcdir)/xml/*.xml $(distdir)/xml
187
	-cp $(srcdir)/html/* $(distdir)/html
188
	-cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
189
	-cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
190
	cd $(distdir) && rm -f $(DISTCLEANFILES)
191
	! which gtkdoc-rebase >/dev/null 2>&1 || \
192
	  gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
193
194
.PHONY : dist-hook-local docs