~ubuntu-branches/ubuntu/lucid/pitivi/lucid

« back to all changes in this revision

Viewing changes to common/gtk-doc.mak

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2009-05-27 14:22:49 UTC
  • mfrom: (1.2.1 upstream) (3.1.13 experimental)
  • Revision ID: james.westby@ubuntu.com-20090527142249-tj0qnkc37320ylml
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
35
35
SCANOBJ_FILES =                         \
36
36
        $(DOC_MODULE).args              \
37
37
        $(DOC_MODULE).hierarchy         \
38
 
        $(DOC_MODULE).interfaces        \
 
38
        $(DOC_MODULE).interfaces                \
39
39
        $(DOC_MODULE).prerequisites     \
40
 
        .libs/$(DOC_MODULE)-scan.o      \
41
 
        $(DOC_MODULE).signals
42
 
 
43
 
CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
 
40
        $(DOC_MODULE).signals           \
 
41
        .libs/$(DOC_MODULE)-scan.o
 
42
 
 
43
REPORT_FILES = \
 
44
        $(DOC_MODULE)-undocumented.txt \
 
45
        $(DOC_MODULE)-undeclared.txt \
 
46
        $(DOC_MODULE)-unused.txt
 
47
 
 
48
CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) doc-registry.xml
44
49
 
45
50
if ENABLE_GTK_DOC
46
51
all-local: html-build.stamp
59
64
            fi ;                                                        \
60
65
            GST_PLUGIN_SYSTEM_PATH=`cd $(top_builddir) && pwd`          \
61
66
            GST_PLUGIN_PATH=                                            \
62
 
            CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)"                         \
63
 
            CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)"          \
 
67
            GST_REGISTRY=doc-registry.xml                               \
 
68
            CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)"                         \
 
69
            CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)"                         \
 
70
            LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)"                         \
64
71
            gtkdoc-scangobj --type-init-func="gst_init(NULL,NULL)"      \
65
72
                --module=$(DOC_MODULE) ;                                \
66
73
        else                                                            \
103
110
 
104
111
#### xml ####
105
112
 
106
 
### FIXME: make this error out again when docs are fixed for 0.9
107
 
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
 
113
### FIXME: make this error out again when docs are complete
 
114
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(expand_content_files)
108
115
        @echo '*** Building XML ***'
109
 
        gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) --output-format=xml $(MKDB_OPTIONS) | tee sgml-build.log
 
116
        gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR)  --expand-content-files="$(expand_content_files)" --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) --output-format=xml $(MKDB_OPTIONS) | tee sgml-build.log
110
117
        @if grep "WARNING:" sgml-build.log > /dev/null; then true; fi # exit 1; fi
 
118
        cp ../version.entities xml
111
119
        rm sgml-build.log
112
120
        touch sgml-build.stamp
113
121
 
125
133
        cp -pr xml html
126
134
        cp ../version.entities html
127
135
        cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
 
136
        mv html/index.sgml html/index.sgml.bak
 
137
        $(SED) "s/ href=\"$(DOC_MODULE)\// href=\"$(DOC_MODULE)-@GST_MAJORMINOR@\//g" html/index.sgml.bak >html/index.sgml
 
138
        rm -f html/index.sgml.bak
128
139
        rm -f html/$(DOC_MAIN_SGML_FILE)
129
140
        rm -rf html/xml
130
141
        rm -f html/version.entities
131
142
        test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
132
143
            if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done
133
 
        @echo '-- Fixing Crossreferences' 
134
 
        gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 
144
        @echo '-- Fixing Crossreferences'
 
145
        gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
135
146
        touch html-build.stamp
 
147
 
 
148
clean-local-gtkdoc:
 
149
        rm -rf xml tmpl html
 
150
# clean files copied for nonsrcdir templates build
 
151
        if test x"$(srcdir)" != x. ; then \
 
152
                rm -rf $(DOC_MODULE).types; \
 
153
        fi
136
154
else
137
155
all-local:
 
156
clean-local-gtkdoc:
138
157
endif
139
158
 
140
 
clean-local:
 
159
clean-local: clean-local-gtkdoc
141
160
        rm -f *~ *.bak
142
 
        rm -rf xml html
143
161
        rm -rf .libs
144
162
 
145
 
maintainer-clean-local: clean
146
 
        cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
147
 
 
148
 
# company: don't delete .sgml and -sections.txt as they're in CVS
 
163
# company: don't delete .sgml and -sections.txt as they're in git
149
164
# FIXME : thomas added all sgml files and some other things to make
150
165
# make distcheck work
151
 
distclean-local: clean
152
 
        rm -f $(DOC_MODULE)-decl-list.txt
153
 
        rm -f $(DOC_MODULE)-decl.txt
154
 
        rm -f $(DOC_MODULE)-undocumented.txt
155
 
        rm -f $(DOC_MODULE)-unused.txt
 
166
distclean-local:
 
167
        rm -f $(REPORT_FILES) \
 
168
                $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
156
169
        rm -rf tmpl/*.sgml.bak
157
170
        rm -f $(DOC_MODULE).hierarchy
158
171
        rm -f *.stamp || true
167
180
        fi
168
181
        rm -rf *.o
169
182
 
 
183
maintainer-clean-local: clean
 
184
        cd $(srcdir) && rm -rf html \
 
185
                xml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 
186
 
170
187
# thomas: make docs parallel installable; devhelp requires majorminor too
171
188
install-data-local:
172
 
        $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) 
173
 
        (installfiles=`echo ./html/*.html`; \
174
 
        if test "$$installfiles" = './html/*.html'; \
 
189
        (installfiles=`echo $(srcdir)/html/*.sgml $(srcdir)/html/*.html $(srcdir)/html/*.png $(srcdir)/html/*.css`; \
 
190
        if test "$$installfiles" = '$(srcdir)/html/*.sgml $(srcdir)/html/*.html $(srcdir)/html/*.png $(srcdir)/html/*.css'; \
175
191
        then echo '-- Nothing to install' ; \
176
192
        else \
 
193
          $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
177
194
          for i in $$installfiles; do \
178
195
            echo '-- Installing '$$i ; \
179
196
            $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
180
197
          done; \
181
 
          pngfiles=`echo ./html/*.png`; \
182
 
          if test "$$pngfiles" != './html/*.png'; then \
183
 
            for i in $$pngfiles; do \
184
 
              echo '-- Installing '$$i ; \
185
 
              $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
186
 
            done; \
187
 
          fi; \
188
198
          echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \
189
199
          $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \
190
200
            $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
191
201
          if test -e $(srcdir)/html/$(DOC_MODULE).devhelp2; then \
192
 
                  $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
 
202
                    $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp2 \
193
203
                   $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
194
204
          fi; \
195
 
          echo '-- Installing $(srcdir)/html/index.sgml' ; \
196
 
          $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
197
 
                if test -e $(srcdir)/html/style.css; then \
198
 
                        echo '-- Installing $(srcdir)/html/style.css' ; \
199
 
                        $(INSTALL_DATA) $(srcdir)/html/style.css $(DESTDIR)$(TARGET_DIR); \
200
 
                fi; \
201
 
        fi) 
 
205
          (which gtkdoc-rebase >/dev/null && \
 
206
            gtkdoc-rebase --relative --dest-dir=$(DESTDIR) --html-dir=$(DESTDIR)$(TARGET_DIR)) || true ; \
 
207
        fi)
202
208
uninstall-local:
203
 
        (installfiles=`echo ./html/*.html`; \
204
 
        if test "$$installfiles" = './html/*.html'; \
205
 
        then echo '-- Nothing to uninstall' ; \
 
209
        if test -d $(DESTDIR)$(TARGET_DIR); then \
 
210
          rm -rf $(DESTDIR)$(TARGET_DIR)/*; \
 
211
          rmdir -p $(DESTDIR)$(TARGET_DIR) 2>/dev/null || true; \
206
212
        else \
207
 
          for i in $$installfiles; do \
208
 
            rmfile=`basename $$i` ; \
209
 
            echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
210
 
            rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
211
 
          done; \
212
 
          pngfiles=`echo ./html/*.png`; \
213
 
          if test "$$pngfiles" != './html/*.png'; then \
214
 
            for i in $$pngfiles; do \
215
 
              rmfile=`basename $$i` ; \
216
 
              echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \
217
 
              rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \
218
 
            done; \
219
 
          fi; \
220
 
          echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \
221
 
          rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \
222
 
          if test -e $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; then \
223
 
            rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp2; \
224
 
          fi; \
225
 
          echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \
226
 
          rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \
227
 
                if test -e $(DESTDIR)$(TARGET_DIR)/style.css; then \
228
 
                        echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/style.css' ; \
229
 
                        rm -f $(DESTDIR)$(TARGET_DIR)/style.css; \
230
 
                fi; \
231
 
        fi) 
232
 
        if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi; true
 
213
          echo '-- Nothing to uninstall' ; \
 
214
        fi;
 
215
 
233
216
 
234
217
#
235
218
# Require gtk-doc when making dist
243
226
endif
244
227
 
245
228
dist-hook: dist-check-gtkdoc dist-hook-local
246
 
        mkdir $(distdir)/tmpl
247
 
        mkdir $(distdir)/xml
248
229
        mkdir $(distdir)/html
249
 
        -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
250
 
        -cp $(srcdir)/sgml/*.xml $(distdir)/xml
251
 
        -cp $(srcdir)/html/index.sgml $(distdir)/html
252
 
        -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
253
 
        -cp $(srcdir)/html/$(DOC_MODULE).devhelp* $(distdir)/html
254
 
 
255
 
        images=$(HTML_IMAGES) ;               \
256
 
        for i in "" $$images ; do                     \
257
 
          if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \
258
 
        done
259
 
 
260
 
.PHONY : dist-hook-local
 
230
        cp $(srcdir)/html/* $(distdir)/html
 
231
        -cp $(srcdir)/$(DOC_MODULE).types $(distdir)/
 
232
        -cp $(srcdir)/$(DOC_MODULE)-sections.txt $(distdir)/
 
233
        cd $(distdir) && rm -f $(DISTCLEANFILES)
 
234
        -gtkdoc-rebase --online --relative --html-dir=$(distdir)/html
 
235
 
 
236
.PHONY : dist-hook-local docs