← Back to branch summary

~matthaeus123/+junk/gupnp-igd

« back to all changes in this revision

Viewing changes to gtk-doc.make

  • Committer: Matthew Walker
  • Date: 2009-03-23 19:36:45 UTC
  • Revision ID: matthew@matthew-desktop-20090323193645-r4z27ojffzc9fuoy
initial checkin

Show diffs side-by-side

added added

removed removed

Lines of Context:
gtk-doc.make
 
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
else
 
11
GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS)
 
12
GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(AM_LDFLAGS) $(LDFLAGS)
 
13
endif
 
14
 
 
15
# We set GPATH here; this gives us semantics for GNU make
 
16
# which are more like other make's VPATH, when it comes to
 
17
# whether a source that is a target of one rule is then
 
18
# searched for in VPATH/GPATH.
 
19
#
 
20
GPATH = $(srcdir)
 
21
 
 
22
TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
 
23
 
 
24
EXTRA_DIST =                            \
 
25
        $(content_files)                \
 
26
        $(HTML_IMAGES)                  \
 
27
        $(DOC_MAIN_SGML_FILE)           \
 
28
        $(DOC_MODULE)-sections.txt      \
 
29
        $(DOC_MODULE)-overrides.txt
 
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
#### scan ####
 
57
 
 
58
scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
 
59
        @echo 'gtk-doc: Scanning header files'
 
60
        @-chmod -R u+w $(srcdir)
 
61
        cd $(srcdir) && \
 
62
          gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
 
63
        if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
 
64
            CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
 
65
        else \
 
66
            cd $(srcdir) ; \
 
67
            for i in $(SCANOBJ_FILES) ; do \
 
68
               test -f $$i || touch $$i ; \
 
69
            done \
 
70
        fi
 
71
        touch scan-build.stamp
 
72
 
 
73
$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp
 
74
        @true
 
75
 
 
76
#### templates ####
 
77
 
 
78
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
 
79
        @echo 'gtk-doc: Rebuilding template files'
 
80
        @-chmod -R u+w $(srcdir)
 
81
        cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
 
82
        touch tmpl-build.stamp
 
83
 
 
84
tmpl.stamp: tmpl-build.stamp
 
85
        @true
 
86
 
 
87
tmpl/*.sgml:
 
88
        @true
 
89
 
 
90
 
 
91
#### xml ####
 
92
 
 
93
sgml-build.stamp: tmpl.stamp $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(srcdir)/tmpl/*.sgml $(expand_content_files)
 
94
        @echo 'gtk-doc: Building XML'
 
95
        @-chmod -R u+w $(srcdir)
 
96
        cd $(srcdir) && \
 
97
        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)
 
98
        touch sgml-build.stamp
 
99
 
 
100
sgml.stamp: sgml-build.stamp
 
101
        @true
 
102
 
 
103
#### html ####
 
104
 
 
105
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 
106
        @echo 'gtk-doc: Building HTML'
 
107
        @-chmod -R u+w $(srcdir)
 
108
        rm -rf $(srcdir)/html
 
109
        mkdir $(srcdir)/html
 
110
        cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 
111
        test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 
112
        @echo 'gtk-doc: Fixing cross-references'
 
113
        cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 
114
        touch html-build.stamp
 
115
 
 
116
##############
 
117
 
 
118
clean-local:
 
119
        rm -f *~ *.bak
 
120
        rm -rf .libs
 
121
 
 
122
distclean-local:
 
123
        cd $(srcdir) && \
 
124
          rm -rf xml $(REPORT_FILES) \
 
125
                 $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 
126
 
 
127
maintainer-clean-local: clean
 
128
        cd $(srcdir) && rm -rf xml html
 
129
 
 
130
install-data-local:
 
131
        -installfiles=`echo $(srcdir)/html/*`; \
 
132
        if test "$$installfiles" = '$(srcdir)/html/*'; \
 
133
        then echo '-- Nothing to install' ; \
 
134
        else \
 
135
          $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
 
136
          for i in $$installfiles; do \
 
137
            echo '-- Installing '$$i ; \
 
138
            $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 
139
          done; \
 
140
          echo '-- Installing $(srcdir)/html/index.sgml' ; \
 
141
          $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \
 
142
          which gtkdoc-rebase >/dev/null && \
 
143
            gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR) ; \
 
144
        fi
 
145
        
 
146
 
 
147
uninstall-local:
 
148
        rm -f $(DESTDIR)$(TARGET_DIR)/*
 
149
 
 
150
#
 
151
# Require gtk-doc when making dist
 
152
#
 
153
if ENABLE_GTK_DOC
 
154
dist-check-gtkdoc:
 
155
else
 
156
dist-check-gtkdoc:
 
157
        @echo "*** gtk-doc must be installed and enabled in order to make dist"
 
158
        @false
 
159
endif
 
160
 
 
161
dist-hook: dist-check-gtkdoc dist-hook-local
 
162
        mkdir $(distdir)/tmpl
 
163
        mkdir $(distdir)/xml
 
164
        mkdir $(distdir)/html
 
165
        -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 
166
        -cp $(srcdir)/xml/*.xml $(distdir)/xml
 
167
        cp $(srcdir)/html/* $(distdir)/html
 
168
        -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
 
169
        -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
 
170
        cd $(distdir) && rm -f $(DISTCLEANFILES)
 
171
        -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
 
172
 
 
173
.PHONY : dist-hook-local docs