doc/Makefile.am

   1 NULL =
   2 ## Process this file with automake to create Makefile.in.
   3
   4 # The name of the module.
   5 DOC_MODULE=gnome-vfs-2.0
   6
   7 # The top-level SGML file.
   8 DOC_MAIN_SGML_FILE=gnome-vfs-2.0-docs.sgml
   9
  10 # The directory containing the source code. Relative to $(srcdir)
  11 DOC_SOURCE_DIR=../libgnomevfs
  12
  13 # Extra options to supply to gtkdoc-scan
  14 SCAN_OPTIONS=
  15
  16 # Extra options to supply to gtkdoc-mkdb
  17 MKDB_OPTIONS=--output-format=xml
  18
  19 # Extra options to supply to gtkdoc-fixref
  20 FIXXREF_OPTIONS=
  21
  22 # Used for dependencies
  23 HFILE_GLOB=$(top_srcdir)/libgnomevfs/*.h
  24 CFILE_GLOB=$(top_srcdir)/libgnomevfs/*.c
  25
  26 # Headers to ignore
  27 IGNORE_HFILES=                                  \
  28         gnome-vfs-async-job-map.h               \
  29         gnome-vfs-backend.h                     \
  30         gnome-vfs-cancellable-ops.h             \
  31         gnome-vfs-configuration.h               \
  32         gnome-vfs-handle-private.h              \
  33         gnome-vfs-i18n.h                        \
  34         gnome-vfs-job-queue.h                   \
  35         gnome-vfs-job-slave.h                   \
  36         gnome-vfs-job.h                         \
  37         gnome-vfs-metadata-private.h            \
  38         gnome-vfs-mime-magic.h                  \
  39         gnome-vfs-mime-private.h                \
  40         gnome-vfs-mime-sniff-buffer.h           \
  41         gnome-vfs-mime-sniff-buffer-private.h   \
  42         gnome-vfs-module-callback-private.h     \
  43         gnome-vfs-monitor-private.h             \
  44         gnome-vfs-private-utils.h               \
  45         gnome-vfs-private.h                     \
  46         gnome-vfs-process.h                     \
  47         gnome-vfs-pthread.h                     \
  48         gnome-vfs-ssl-private.h                 \
  49         gnome-vfs-thread-pool.h
  50         $(NULL)
  51
  52 # Extra files to add when scanning
  53 EXTRA_HFILES=
  54
  55 # Images to copy into HTML directory
  56 HTML_IMAGES =
  57
  58 # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
  59 content_files =                 \
  60         writing-modules.sgml    \
  61         about.sgml
  62
  63 extra_files =
  64
  65 # CFLAGS and LDFLAGS for compiling scan program. Only needed
  66 # if $(DOC_MODULE).types is non-empty.
  67 GTKDOC_CFLAGS =
  68 GTKDOC_LIBS =
  69
  70 # Commands for compiling and linking
  71 GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
  72 GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
  73
  74 dist-hook-local:
  75 #       mkdir $(distdir)/TEXT;          \
  76 #       for f in $(srcdir)/TEXT/* ; do  \
  77 #         test -f $$f && cp -p $$f $(distdir)/TEXT; \
  78 #       done
  79
  80
  81 ####################################
  82 # Everything below here is generic #
  83 ####################################
  84
  85 # ... except for TARGET_DIR, which we override
  86
  87 TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
  88
  89 EXTRA_DIST =                            \
  90         $(content_files)                \
  91         $(extra_files)                  \
  92         $(HTML_IMAGES)                  \
  93         $(DOC_MAIN_SGML_FILE)           \
  94         $(DOC_MODULE).types             \
  95         $(DOC_MODULE)-sections.txt      \
  96         $(DOC_MODULE)-overrides.txt
  97
  98 DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
  99            $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp
 100
 101 SCANOBJ_FILES =                 \
 102         $(DOC_MODULE).args      \
 103         $(DOC_MODULE).hierarchy \
 104         $(DOC_MODULE).signals
 105
 106 if ENABLE_GTK_DOC
 107 all-local: html-build.stamp
 108
 109 #### scan ####
 110
 111 scan-build.stamp: $(HFILE_GLOB)
 112         @echo '*** Scanning header files ***'
 113         if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
 114             CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
 115         else \
 116             cd $(srcdir) ; \
 117             for i in $(SCANOBJ_FILES) ; do \
 118                test -f $$i || touch $$i ; \
 119             done \
 120         fi
 121         cd $(srcdir) && \
 122           gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
 123         touch scan-build.stamp
 124
 125 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
 126         @true
 127
 128 #### templates ####
 129
 130 tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
 131         @echo '*** Rebuilding template files ***'
 132         cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
 133         touch tmpl-build.stamp
 134
 135 tmpl.stamp: tmpl-build.stamp
 136         touch $(srcdir)/tmpl.stamp
 137
 138 #### sgml ####
 139
 140 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
 141         @echo '*** Building SGML ***'
 142         cd $(srcdir) && \
 143         gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
 144         touch sgml-build.stamp
 145
 146 sgml.stamp: sgml-build.stamp
 147         touch $(srcdir)/sgml.stamp
 148
 149 #### html ####
 150
 151 html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 152         @echo '*** Building HTML ***'
 153         test -d $(srcdir)/html || mkdir $(srcdir)/html
 154         cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
 155         test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
 156         @echo '-- Fixing Crossreferences'
 157         cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
 158         touch html-build.stamp
 159 endif
 160
 161 ##############
 162
 163 clean-local:
 164         rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
 165
 166 maintainer-clean-local: clean
 167         cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
 168
 169 install-data-local:
 170         $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
 171         (installfiles=`echo $(srcdir)/html/*`; \
 172         if test "$$installfiles" = '$(srcdir)/html/*'; \
 173         then echo '-- Nothing to install' ; \
 174         else \
 175           for i in $$installfiles; do \
 176             echo '-- Installing '$$i ; \
 177             $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
 178           done; \
 179           echo '-- Installing $(srcdir)/html/index.sgml' ; \
 180           $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
 181         fi)
 182
 183 #
 184 # Require gtk-doc when making dist
 185 #
 186 if ENABLE_GTK_DOC
 187 dist-check-gtkdoc:
 188 else
 189 dist-check-gtkdoc:
 190         @echo "*** gtk-doc must be installed and enabled in order to make dist"
 191         @false
 192 endif
 193
 194 dist-hook: dist-check-gtkdoc dist-hook-local
 195         test -d $(distdir)/tmpl || mkdir $(distdir)/tmpl
 196         test -d $(distdir)/xml || mkdir $(distdir)/xml
 197         test -d $(distdir)/html || mkdir $(distdir)/html
 198         -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
 199         -cp $(srcdir)/xml/*.xml $(distdir)/xml
 200         -cp $(srcdir)/html/index.sgml $(distdir)/html
 201         -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html
 202
 203         images=$(HTML_IMAGES) ;               \
 204         for i in $$images ; do                \
 205           cp $(srcdir)/$$i $(distdir)/html ;  \
 206         done
 207
 208 .PHONY : dist-hook-local