← Back to branch summary

~carsten-munk/m-r/libhildon-2.1.24

« back to all changes in this revision

Viewing changes to doc/gtk-doc.make

  • Committer: Carsten V. Munk
  • Date: 2008-12-08 15:00:57 UTC
  • Revision ID: cvm@cs.au.dk-20081208150057-7e0a50c8zdupbzar
initial commit of 2.1.24

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/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_CFLAGS) $(CFLAGS)
 
9
GTKDOC_LD = $(LIBTOOL) --mode=link $(CC) $(AM_CFLAGS) $(CFLAGS) $(LDFLAGS)
 
10
else
 
11
GTKDOC_CC = $(CC) $(INCLUDES) $(AM_CFLAGS) $(CFLAGS)
 
12
GTKDOC_LD = $(CC) $(AM_CFLAGS) $(CFLAGS) $(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
CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
 
42
 
 
43
if ENABLE_GTK_DOC
 
44
all-local: html-build.stamp
 
45
 
 
46
#### scan ####
 
47
 
 
48
scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB)
 
49
        @echo 'gtk-doc: Scanning header files'
 
50
        @-chmod -R u+w $(srcdir)
 
51
        if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null 2>&1 ; then \
 
52
            CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj $(SCANGOBJ_OPTIONS) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
 
53
        else \
 
54
            cd $(srcdir) ; \
 
55
            for i in $(SCANOBJ_FILES) ; do \
 
56
               test -f $$i || touch $$i ; \
 
57
            done \
 
58
        fi
 
59
        cd $(srcdir) && \
 
60
          gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
 
61
        touch scan-build.stamp
 
62
 
 
63
$(DOC_MODULE)-decl.txt $(DOC_MODULE)-sections.txt $(SCANOBJ_FILES): scan-build.stamp
 
64
        @true
 
65
 
 
66
#### templates ####
 
67
 
 
68
tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
 
69
        @echo 'gtk-doc: Rebuilding template files'
 
70
        @-chmod -R u+w $(srcdir)
 
71
        cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) $(MKTMPL_OPTIONS)
 
72
        touch tmpl-build.stamp
 
73
 
 
74
tmpl.stamp: tmpl-build.stamp
 
75
        @true
 
76
 
 
77
#### xml ####
 
78
tmpl_files := $(wildcard $(srcdir)/tmpl/*.sgml)
 
79
 
 
80
sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(tmpl_files) $(expand_content_files)
 
81
        @echo 'gtk-doc: Building XML'
 
82
        @-chmod -R u+w $(srcdir)
 
83
        cd $(srcdir) && \
 
84
        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)
 
85
        touch sgml-build.stamp
 
86
 
 
87
sgml.stamp: sgml-build.stamp
 
88
        @true
 
89
 
 
90
#### html ####
 
91
 
 
92
html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 
93
        @echo 'gtk-doc: Building HTML'
 
94
        @-chmod -R u+w $(srcdir)
 
95
        rm -rf $(srcdir)/html 
 
96
        mkdir $(srcdir)/html
 
97
        cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 
98
        test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 
99
        @echo 'gtk-doc: Fixing cross-references' 
 
100
        cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 
101
        touch html-build.stamp
 
102
else
 
103
all-local:
 
104
endif
 
105
 
 
106
##############
 
107
 
 
108
clean-local:
 
109
        rm -f *~ *.bak
 
110
        rm -rf .libs
 
111
 
 
112
maintainer-clean-local: clean
 
113
        cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 
114
 
 
115
install-data-local:
 
116
        installfiles=`echo $(srcdir)/html/*`; \
 
117
        if test "$$installfiles" = '$(srcdir)/html/*'; \
 
118
        then echo '-- Nothing to install' ; \
 
119
        else \
 
120
          $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR); \
 
121
          for i in $$installfiles; do \
 
122
            echo '-- Installing '$$i ; \
 
123
            $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 
124
          done; \
 
125
          echo '-- Installing $(srcdir)/html/index.sgml' ; \
 
126
          $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR) || :; \
 
127
        fi
 
128
 
 
129
uninstall-local:
 
130
        rm -f $(DESTDIR)$(TARGET_DIR)/*
 
131
 
 
132
#
 
133
# Require gtk-doc when making dist
 
134
#
 
135
if ENABLE_GTK_DOC
 
136
dist-check-gtkdoc:
 
137
else
 
138
dist-check-gtkdoc:
 
139
        @echo "*** gtk-doc must be installed and enabled in order to make dist"
 
140
        @false
 
141
endif
 
142
 
 
143
dist-hook: dist-check-gtkdoc dist-hook-local
 
144
        mkdir $(distdir)/tmpl
 
145
        mkdir $(distdir)/xml
 
146
        mkdir $(distdir)/html
 
147
        -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 
148
        -cp $(srcdir)/xml/*.xml $(distdir)/xml
 
149
        -cp $(srcdir)/html/* $(distdir)/html
 
150
        if test -f $(srcdir)/$(DOC_MODULE).types; then \
 
151
          cp $(srcdir)/$(DOC_MODULE).types $(distdir)/$(DOC_MODULE).types; \
 
152
        fi
 
153
 
 
154
.PHONY : dist-hook-local