More docs fixes
[platform/upstream/glib.git] / docs / reference / glib / Makefile.am
index 20df292..27fdf0b 100644 (file)
@@ -1,4 +1,7 @@
 ## Process this file with automake to produce Makefile.in
+include $(top_srcdir)/Makefile.decl
+
+AUTOMAKE_OPTIONS = 1.6
 
 # The name of the module.
 DOC_MODULE=glib
@@ -7,16 +10,13 @@ DOC_MODULE=glib
 DOC_MAIN_SGML_FILE=glib-docs.sgml
 
 # The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR=../../..
+DOC_SOURCE_DIR=../../../glib ../../../gmodule
 
 # Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED"
+SCAN_OPTIONS=--deprecated-guards="G_DISABLE_DEPRECATED" --ignore-decorators="GLIB_VAR"
 
 # Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode
-
-# Extra options to supply to gtkdoc-fixref
-FIXXREF_OPTIONS=
+MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=g
 
 # Used for dependencies
 HFILE_GLOB=$(top_srcdir)/glib/*.h $(top_srcdir)/gmodule/*.h
@@ -24,8 +24,7 @@ CFILE_GLOB=$(top_srcdir)/glib/*.c $(top_srcdir)/gmodule/*.c
 
 # Headers to ignore
 IGNORE_HFILES=                 \
-       gobject                 \
-       config.h                \
+       gdatasetprivate.h       \
        glibintl.h              \
        gbsearcharray.h         \
        gmoduleconf.h           \
@@ -33,159 +32,89 @@ IGNORE_HFILES=                     \
        gunicomp.h              \
        gunidecomp.h            \
        gunichartables.h        \
-       glibconfig-sysdefs.h
-
-# Extra files to add when scanning
-EXTRA_HFILES=
+       glib_trace.h            \
+       libcharset.h            \
+       gdebug.h                \
+       gprintfint.h            \
+       gmirroringtable.h       \
+       gscripttable.h          \
+       glib-mirroring-tab      \
+       gnulib                  \
+       pcre                    \
+       update-pcre             \
+       gbuffer.h               \
+       gvariant-internal.h     \
+       gvariant-serialiser.h   \
+       gvariant-core.h         \
+       gvarianttypeinfo.h
 
 # Images to copy into HTML directory
 HTML_IMAGES =                                  \
+       file-name-encodings.png         \
        mainloop-states.gif
 
 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
-content_files =
+content_files =                                \
+       cross.sgml                      \
+       running.sgml                    \
+       building.sgml                   \
+       changes.sgml                    \
+       compiling.sgml                  \
+       resources.sgml                  \
+       regex-syntax.sgml               \
+       version.xml                     \
+       glib-gettextize.xml             \
+       gtester.xml                     \
+       gtester-report.xml              \
+       gvariant-varargs.xml
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS=
+
+# include common portion ...
+include $(top_srcdir)/gtk-doc.make
 
 # Other files to distribute
-extra_files =                          \
+EXTRA_DIST +=                          \
+       file-name-encodings.png         \
+       file-name-encodings.sxd         \
        mainloop-states.fig             \
        mainloop-states.png             \
-       mainloop-states.eps
-
-# CFLAGS and LDFLAGS for compiling scan program. Only needed
-# if $(DOC_MODULE).types is non-empty.
-GTKDOC_CFLAGS =
-GTKDOC_LIBS =
-
-# Commands for compiling and linking 
-GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC)
-GTKDOC_LD=$(LIBTOOL) --mode=link $(CC)
-
-
-####################################
-# Everything below here is generic #
-####################################
-
-# We set GPATH here; this gives us semantics for GNU make
-# which are more like other make's VPATH, when it comes to
-# whether a source that is a target of one rule is then
-# searched for in VPATH/GPATH.
-#
-GPATH = $(srcdir)
-
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
-
-EXTRA_DIST =                           \
-       $(content_files)                \
-       $(extra_files)                  \
-       $(HTML_IMAGES)                  \
-       $(DOC_MAIN_SGML_FILE)           \
-       $(DOC_MODULE).types             \
-       $(DOC_MODULE)-sections.txt      \
-       $(DOC_MODULE)-overrides.txt
-
-DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
-          $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
-
-SCANOBJ_FILES =                \
-       $(DOC_MODULE).args      \
-       $(DOC_MODULE).hierarchy \
-       $(DOC_MODULE).signals
-
-if ENABLE_GTK_DOC
-all-local: html-build.stamp
-
-#### scan ####
-
-scan-build.stamp: $(HFILE_GLOB)
-       @echo '*** Scanning header files ***'
-       if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
-           CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
-       else \
-           cd $(srcdir) ; \
-           for i in $(SCANOBJ_FILES) ; do \
-               test -f $$i || touch $$i ; \
-           done \
-       fi
-       cd $(srcdir) && \
-         gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
-       touch scan-build.stamp
-
-$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
-       @true
-
-#### templates ####
-
-tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt
-       @echo '*** Rebuilding template files ***'
-       cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE)
-       touch tmpl-build.stamp
-
-tmpl.stamp: tmpl-build.stamp
-       @true
-
-#### sgml ####
-
-sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) $(srcdir)/tmpl/*.sgml
-       @echo '*** Building SGML ***'
-       cd $(srcdir) && \
-       gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS)
-       touch sgml-build.stamp
-
-sgml.stamp: sgml-build.stamp
-       @true
-
-#### html ####
-
-html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
-       @echo '*** Building HTML ***'
-       rm -rf $(srcdir)/html 
-       mkdir $(srcdir)/html
-       cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
-       test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html )
-       @echo '-- Fixing Crossreferences' 
-       cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
-       touch html-build.stamp
-endif
+       mainloop-states.eps             \
+       version.xml.in
+
+########################################################################
+
+man_MANS =                     \
+       glib-gettextize.1       \
+       gtester.1               \
+       gtester-report.1
+
+if ENABLE_MAN
+
+.xml.1:
+       @XSLTPROC@ -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+
+dist-local-check-mans-enabled:
+       if grep "Man generation disabled" $(man_MANS) >/dev/null; then $(RM) $(man_MANS); fi
 
-##############
-
-clean-local:
-       rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS)
-
-maintainer-clean-local: clean
-       cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
-
-install-data-local:
-       $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR)
-       (installfiles=`echo $(srcdir)/html/*`; \
-       if test "$$installfiles" = '$(srcdir)/html/*'; \
-       then echo '-- Nothing to install' ; \
-       else \
-         for i in $$installfiles; do \
-           echo '-- Installing '$$i ; \
-           $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \
-         done; \
-         echo '-- Installing $(srcdir)/html/index.sgml' ; \
-         $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \
-       fi)
-
-#
-# Require gtk-doc when making dist
-#
-if ENABLE_GTK_DOC
-dist-check-gtkdoc:
 else
-dist-check-gtkdoc:
-       @echo "*** gtk-doc must be installed and enabled in order to make dist"
-       @false
+
+$(man_MANS):
+       echo Man generation disabled.  Creating dummy $@.  Configure with --enable-man to enable it.
+       echo Man generation disabled.  Remove this file, configure with --enable-man, and rebuild > $@
+
+dist-local-check-mans-enabled:
+       echo "*** --enable-man must be used in order to make dist"
+       false
+
 endif
 
-dist-hook: dist-check-gtkdoc dist-hook-local
-       mkdir $(distdir)/tmpl
-       mkdir $(distdir)/sgml
-       mkdir $(distdir)/html
-       -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl
-       -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml
-       -cp $(srcdir)/html/* $(distdir)/html
+MAINTAINERCLEANFILES = $(man_MANS) $(BUILT_SOURCES)
+
+EXTRA_DIST += $(man_MANS)
+
+dist-hook-local: dist-local-check-mans-enabled glib-docs-clean all-local
 
-.PHONY : dist-hook-local
+glib-docs-clean: clean
+       cd $(srcdir) && rm -rf xml html