diff options
Diffstat (limited to 'help')
| -rw-r--r-- | help/devel/ChangeLog | 10 | ||||
| -rw-r--r-- | help/devel/Makefile.am | 141 | ||||
| -rw-r--r-- | help/devel/calendar/cal-client/Makefile.am | 264 | ||||
| -rw-r--r-- | help/devel/calendar/cal-util/Makefile.am | 280 | ||||
| -rw-r--r-- | help/devel/executive-summary/Makefile.am | 262 | ||||
| -rw-r--r-- | help/devel/importer/Makefile.am | 256 |
6 files changed, 785 insertions, 428 deletions
diff --git a/help/devel/ChangeLog b/help/devel/ChangeLog index 46fdde47c8..42f4f3ea9a 100644 --- a/help/devel/ChangeLog +++ b/help/devel/ChangeLog @@ -1,3 +1,13 @@ +2001-06-21 Peter Williams <peterw@ximian.com> + + * Makefile.am: + calendar/cal-client/Makefile.am: + calendar/cal-util/Makefile.am: + importer/Makefile.am: + executive-summary/Makefile.am: Changed to used gtk-doc's + canonical Makefile.am (plus some tweaks because not every + dir builds html). + 2001-06-14 Damon Chaplin <damon@ximian.com> * executive-summary/.cvsignore: diff --git a/help/devel/Makefile.am b/help/devel/Makefile.am index 200905cffe..a832b8ea22 100644 --- a/help/devel/Makefile.am +++ b/help/devel/Makefile.am @@ -1,22 +1,37 @@ +## Process this file with automake to produce Makefile.in + SUBDIRS = calendar executive-summary -# The name of the module. +# The name of the module, e.g. 'glib'. DOC_MODULE=evolution-devel-guide -# The top-level SGML file. +# The top-level SGML file. Change it if you want. DOC_MAIN_SGML_FILE=evolution-devel-guide.sgml -HTML_DIR=$(datadir)/gnome/html +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. +#DOC_SOURCE_DIR= -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) +# Extra options to supply to gtkdoc-scan. +#SCAN_OPTIONS= -# Add your toplevel files here +# Extra options to supply to gtkdoc-mkdb. +#MKDB_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. +#FIXXREF_OPTIONS= + +# Used for dependencies. +#HFILE_GLOB= +#CFILE_GLOB= + +# Header files to ignore when scanning. +#IGNORE_HFILES= + +# Images to copy into HTML directory. +HTML_IMAGES = -content_files = \ - evolution-devel-guide.sgml \ - fdl.sgml \ - preface.sgml \ - reference.sgml # Add your module's hand-written and auto-generated files here; these # are used for dependency tracking. @@ -42,26 +57,78 @@ local_entities = \ # importer/sgml/evolution-importer.sgml \ # importer/sgml/evolution-importer-client.sgml -EXTRA_DIST = \ - $(content_files) +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = \ + evolution-devel-guide.sgml \ + fdl.sgml \ + preface.sgml \ + reference.sgml \ + $(local_entities) + +# Other files to distribute. +extra_files = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib +# contains GtkObjects/GObjects and you want to document signals and properties. +#GTKDOC_CFLAGS = +#GTKDOC_LIBS = +# +#GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) +#GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) + +# If you need to override some of the declarations, place them in this file +# and uncomment this line. +#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt + +HTML_DIR = $(datadir)/gnome/html -all: html/index.html +########################################################################### +# Everything below here is generic and you shouldn't need to change it. +########################################################################### + +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_OVERRIDES) + +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 -html/index.html: $(content_files) $(local_entities) +all-local: html-build.stamp + +#### html #### + +html-build.stamp: $(DOC_MAIN_SGML_FILE) $(content_files) #sgml.stamp + @echo '*** Building HTML ***' test -d $(srcdir)/html || mkdir $(srcdir)/html - -cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) -else -html/index.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 +############## + clean-local: - rm -f *~ *.bak *.signals *-unused.txt + rm -f *~ *.bak *-unused.txt $(DOC_STAMPS) # $(SCANOBJ_FILES) -maintainer-clean-local: - cd $(srcdir) && rm -rf html +maintainer-clean-local: clean + cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt -if ENABLE_GTK_DOC install-data-local: $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) (installfiles=`echo $(srcdir)/html/*.html`; \ @@ -72,13 +139,35 @@ install-data-local: 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); \ - echo '-- Fixing Crossreferences' ; \ - gtkdoc-fixxref --module=$(DOC_MODULE) --html-dir=$(HTML_DIR)|| true; \ fi) + +# echo '-- Installing $(srcdir)/html/index.sgml' ; \ +# $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ + +# +# 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 endif -dist-hook: +dist-hook: dist-check-gtkdoc dist-hook-local mkdir $(distdir)/html + -cp $(srcdir)/html/index.sgml $(distdir)/html -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html + + images=$(HTML_IMAGES) ; \ + for i in $$images ; do \ + cp $(srcdir)/$$i $(distdir)/html ; \ + done + +# mkdir $(distdir)/tmpl +# mkdir $(distdir)/sgml +# -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml +# -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl + +.PHONY : dist-hook-local diff --git a/help/devel/calendar/cal-client/Makefile.am b/help/devel/calendar/cal-client/Makefile.am index 109bdcc241..a3e339e5a9 100644 --- a/help/devel/calendar/cal-client/Makefile.am +++ b/help/devel/calendar/cal-client/Makefile.am @@ -1,131 +1,197 @@ # The name of the module. DOC_MODULE=evolution-cal-client -# The directory containing the source code (if it contains documentation). +# The top-level SGML file. Change it if you want. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client -CFLAGS =" \ +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS= + +# Used for dependencies. +HFILE_GLOB= \ + $(top_srcdir)/calendar/cal-client/cal-client.c \ + $(top_srcdir)/calendar/cal-client/cal-client-types.c + +CFILE_GLOB= \ + $(top_srcdir)/calendar/cal-client/cal-client.h \ + $(top_srcdir)/calendar/cal-client/cal-client-types.h + +# Header files to ignore when scanning. +IGNORE_HFILES= \ + cal-listener.h \ + evolution-calendar.h + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# Other files to distribute. +extra_files = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib +# contains GtkObjects/GObjects and you want to document signals and properties. +GTKDOC_CFLAGS= \ -I$(top_srcdir)/calendar \ -I$(top_srcdir) \ -I$(top_builddir) \ -I$(top_builddir)/libical/src/libical \ -I$(top_srcdir)/libical/src/libical \ - $(BONOBO_VFS_GNOME_CFLAGS) \ - " + $(BONOBO_VFS_GNOME_CFLAGS) -LDFLAGS=" \ +GTKDOC_LIBS= \ $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-client/.libs/libcal-client.a \ - $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/.libs/libical.a \ - $(top_builddir)/libversit/.libs/libversit.al \ - " - -DOC_DIR=$(datadir)/gnome/html - -DOC_DIR_INSTALL_FILES = \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals \ - evolution-cal-client.types \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt - -SOURCE_FILES = \ - $(top_srcdir)/calendar/cal-client/cal-client.c \ - $(top_srcdir)/calendar/cal-client/cal-client.h \ - $(top_srcdir)/calendar/cal-client/cal-client-types.c \ - $(top_srcdir)/calendar/cal-client/cal-client-types.h + $(top_builddir)/calendar/cal-client/.libs/libcal-client-static.al\ + $(top_builddir)/calendar/cal-util/.libs/libcal-util-static.al \ + $(top_builddir)/libical/src/libical/.libs/libical-static.al \ + $(top_builddir)/libversit/.libs/libversit.al -IGNORED_HEADER_FILES = \ - cal-listener.h \ - evolution-calendar.h +GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) +GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) -scan_generated = \ - evolution-cal-client-decl.txt \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals \ - evolution-cal-client.types - -tmpl_dependencies = \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals - -tmpl_sources = \ - tmpl/cal-client.sgml \ - tmpl/evolution-cal-client-unused.sgml - -tmpl_generated = \ - evolution-cal-client-unused.txt - -sgml_dependencies = \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals \ - tmpl/cal-client.sgml - -sgml_generated = \ - sgml/cal-client.sgml \ - sgml/evolution-cal-client-doc.bottom \ - sgml/evolution-cal-client-doc.top \ - sgml/object_index.sgml \ - sgml/tree_index.sgml - -EXTRA_DIST = \ - evolution-cal-client.args \ - evolution-cal-client.hierarchy \ - evolution-cal-client.signals \ - evolution-cal-client.types \ - evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt - -all: $(sgml_generated) +# If you need to override some of the declarations, place them in this file +# and uncomment this line. +#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt +DOC_OVERRIDES = + +#DOC_DIR=$(datadir)/gnome/html + +########################################################################### +# Everything below here is generic and you shouldn't need to change it. +########################################################################### + +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_OVERRIDES) + +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 -scan $(scan_generated): $(SOURCE_FILES) - -(ln -sf $(srcdir)/$(DOC_MODULE).types . \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ - --ignore-headers="$(IGNORED_HEADER_FILES)" ) - -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) +#all-local: html-build.stamp +all-local: sgml-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-scanobj --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_OVERRIDES) + @echo '*** Rebuilding template files ***' cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + touch tmpl-build.stamp -sgml $(sgml_generated): $(sgml_dependencies) - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) -else -scan $(scan_generated): $(SOURCE_FILES) +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) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) + touch sgml-build.stamp + +sgml.stamp: sgml-build.stamp + @true -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) +#### html #### -sgml $(sgml_generated): $(sgml_dependencies) +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo '*** Building HTML ***' + test -d $(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 +############## + clean-local: - rm -f *~ *.bak *.signals *-unused.txt + rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt install-data-local: - $(mkinstalldirs) $(DOC_DIR) - for i in $(DOC_DIR_INSTALL_FILES); do \ - $(INSTALL_DATA) $(srcdir)/$$i $(DOC_DIR); \ - done + $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) + (installfiles=`echo $(srcdir)/html/*.html`; \ + if test "$$installfiles" = '$(srcdir)/html/*.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 +endif -dist-hook: - mkdir $(distdir)/sgml +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)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml + -cp $(srcdir)/html/index.sgml $(distdir)/html + -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html + + images=$(HTML_IMAGES) ; \ + for i in $$images ; do \ + cp $(srcdir)/$$i $(distdir)/html ; \ + done -.PHONY: scan templates sgml +.PHONY : dist-hook-local diff --git a/help/devel/calendar/cal-util/Makefile.am b/help/devel/calendar/cal-util/Makefile.am index 291cb46f2d..fd697713ce 100644 --- a/help/devel/calendar/cal-util/Makefile.am +++ b/help/devel/calendar/cal-util/Makefile.am @@ -1,142 +1,200 @@ -# The name of the module. +## Process this file with automake to produce Makefile.in + +# The name of the module, e.g. 'glib'. DOC_MODULE=evolution-cal-util -# The directory containing the source code (if it contains documentation). +# The top-level SGML file. Change it if you want. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-util -CFLAGS =" \ +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS= + +# Used for dependencies. +HFILE_GLOB= \ + $(top_srcdir)/calendar/cal-util/cal-component.h \ + $(top_srcdir)/calendar/cal-util/cal-recur.h \ + $(top_srcdir)/calendar/cal-util/cal-util.h \ + $(top_srcdir)/calendar/cal-util/timeutil.h + +CFILE_GLOB= \ + $(top_srcdir)/calendar/cal-util/cal-component.c \ + $(top_srcdir)/calendar/cal-util/cal-recur.c \ + $(top_srcdir)/calendar/cal-util/cal-util.c \ + $(top_srcdir)/calendar/cal-util/timeutil.c + + +# Header files to ignore when scanning. +IGNORE_HFILES= \ + calobj.h + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# Other files to distribute. +extra_files = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib +# contains GtkObjects/GObjects and you want to document signals and properties. +GTKDOC_CFLAGS = \ -I$(top_srcdir)/calendar \ -I$(top_srcdir) \ -I$(top_builddir) \ -I$(top_builddir)/libical/src/libical \ -I$(top_srcdir)/libical/src/libical \ - $(BONOBO_VFS_GNOME_CFLAGS) \ - " + $(BONOBO_VFS_GNOME_CFLAGS) -LDFLAGS=" \ +GTKDOC_LIBS = \ $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/.libs/libical.a \ - $(top_builddir)/libversit/.libs/libversit.al \ - " - -DOC_DIR=$(datadir)/gnome/html - -DOC_DIR_INSTALL_FILES = \ - evolution-cal-util.args \ - evolution-cal-util.hierarchy \ - evolution-cal-util.signals \ - evolution-cal-util.types \ - evolution-cal-util-decl.txt \ - evolution-cal-util-sections.txt - -SOURCE_FILES = \ - $(top_srcdir)/calendar/cal-util/cal-component.c \ - $(top_srcdir)/calendar/cal-util/cal-component.h \ - $(top_srcdir)/calendar/cal-util/cal-recur.c \ - $(top_srcdir)/calendar/cal-util/cal-recur.h \ - $(top_srcdir)/calendar/cal-util/cal-util.c \ - $(top_srcdir)/calendar/cal-util/cal-util.h \ - $(top_srcdir)/calendar/cal-util/timeutil.c \ - $(top_srcdir)/calendar/cal-util/timeutil.h + $(top_builddir)/calendar/cal-util/.libs/libcal-util-static.al \ + $(top_builddir)/libical/src/libical/.libs/libical-static.al \ + $(top_builddir)/libversit/.libs/libversit.al -IGNORED_HEADER_FILES = \ - calobj.h +GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) +GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) + +# If you need to override some of the declarations, place them in this file +# and uncomment this line. +#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt +DOC_OVERRIDES = -scan_generated = \ - evolution-cal-util-decl.txt \ - evolution-cal-util.args \ - evolution-cal-util.hierarchy \ - evolution-cal-util.signals \ - evolution-cal-util.types - -tmpl_dependencies = \ - evolution-cal-util-decl.txt \ - evolution-cal-util-sections.txt \ - evolution-cal-util.args \ - evolution-cal-util.hierarchy \ - evolution-cal-util.signals - -tmpl_sources = \ - tmpl/cal-component.sgml \ - tmpl/cal-recur.sgml \ - tmpl/cal-util.sgml \ - tmpl/evolution-cal-util-unused.sgml \ - tmpl/timeutil.sgml - -tmpl_generated = \ - evolution-cal-util-unused.txt - -sgml_dependencies = \ - evolution-cal-util-decl.txt \ - evolution-cal-util-sections.txt \ - evolution-cal-util.args \ - evolution-cal-util.hierarchy \ - evolution-cal-util.signals \ - tmpl/cal-component.sgml \ - tmpl/cal-recur.sgml \ - tmpl/cal-util.sgml \ - tmpl/timeutil.sgml - -sgml_generated = \ - sgml/cal-component.sgml \ - sgml/cal-recur.sgml \ - sgml/cal-util.sgml \ - sgml/evolution-cal-util-doc.bottom \ - sgml/evolution-cal-util-doc.top \ - sgml/object_index.sgml \ - sgml/timeutil.sgml \ - sgml/tree_index.sgml - -EXTRA_DIST = \ - evolution-cal-util.args \ - evolution-cal-util.hierarchy \ - evolution-cal-util.signals \ - evolution-cal-util.types \ - evolution-cal-util-decl.txt \ - evolution-cal-util-sections.txt - -all: $(sgml_generated) +########################################################################### +# Everything below here is generic and you shouldn't need to change it. +########################################################################### + +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_OVERRIDES) + +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 -scan $(scan_generated): $(SOURCE_FILES) - -(ln -sf $(srcdir)/$(DOC_MODULE).types . \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ - --ignore-headers="$(IGNORED_HEADER_FILES)" ) - -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) +all-local: sgml-build.stamp +#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-scanobj --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_OVERRIDES) + @echo '*** Rebuilding template files ***' cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + touch tmpl-build.stamp -sgml $(sgml_generated): $(sgml_dependencies) - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) -else -scan $(scan_generated): $(SOURCE_FILES) +tmpl.stamp: tmpl-build.stamp + @true + +#### sgml #### -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) +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) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS) + touch sgml-build.stamp -sgml $(sgml_generated): $(sgml_dependencies) +sgml.stamp: sgml-build.stamp + @true + +#### html #### + +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) + @echo '*** Building HTML ***' + test -d $(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 +############## + clean-local: - rm -f *~ *.bak *.signals *-unused.txt + rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt install-data-local: - $(mkinstalldirs) $(DOC_DIR) - for i in $(DOC_DIR_INSTALL_FILES); do \ - $(INSTALL_DATA) $(srcdir)/$$i $(DOC_DIR); \ - done + $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) + (installfiles=`echo $(srcdir)/html/*.html`; \ + if test "$$installfiles" = '$(srcdir)/html/*.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 +endif -dist-hook: - mkdir $(distdir)/sgml +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)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml + -cp $(srcdir)/html/index.sgml $(distdir)/html + -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html + + images=$(HTML_IMAGES) ; \ + for i in $$images ; do \ + cp $(srcdir)/$$i $(distdir)/html ; \ + done -.PHONY: scan templates sgml +.PHONY : dist-hook-local
\ No newline at end of file diff --git a/help/devel/executive-summary/Makefile.am b/help/devel/executive-summary/Makefile.am index a310f6c917..9e0901bd9f 100644 --- a/help/devel/executive-summary/Makefile.am +++ b/help/devel/executive-summary/Makefile.am @@ -1,125 +1,191 @@ -# The name of the module. +## Process this file with automake to produce Makefile.in + +# The name of the module, e.g. 'glib'. DOC_MODULE=evolution-services -# The directory containing the source code +# The top-level SGML file. Change it if you want. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. DOC_SOURCE_DIR=$(EVOLUTION_DIR)/executive-summary/evolution-services -CFLAGS =" \ +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS= + +# Used for dependencies. +HFILE_GLOB= +CFILE_GLOB= \ + $(top_srcdir)/executive-summary/evolution-services/executive-summary-component.c \ + $(top_srcdir)/executive-summary/evolution-services/executive-summary-component-factory-client.c \ + $(top_srcdir)/executive-summary/evolution-services/executive-summary-html-view.c + + +# Header files to ignore when scanning. +IGNORE_HFILES=Executive-Summary.h + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# Other files to distribute. +extra_files = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib +# contains GtkObjects/GObjects and you want to document signals and properties. +GTKDOC_CFLAGS = \ -I$(top_srcdir)/executive-summary/evolution-services \ -I$(top_srcdir)/executive-summary \ - -I$(top_srcdir) \ - -I$(top_builddir) \ - $(BONOBO_VFS_GNOME_CFLAGS) \ - " + -I$(top_srcdir) \ + -I$(top_builddir) \ + $(BONOBO_VFS_GNOME_CFLAGS) -LDFLAGS=" \ +GTKDOC_LIBS = \ $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/executive-summary/evolution-services/.libs/libevolution-services.a \ - " - -DOC_DIR=$(datadir)/gnome/html - -DOC_DIR_INSTALL_FILES = \ - evolution-services.args \ - evolution-services.hierarchy \ - evolution-services.signals \ - evolution-services.types \ - evolution-services-decl.txt \ - evolution-services-sections.txt - -SOURCE_FILES = \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-component.c \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-component-factory-client.c \ - $(top_srcdir)/executive-summary/evolution-services/executive-summary-html-view.c + $(top_builddir)/executive-summary/evolution-services/.libs/libevolution-services.so + +GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) +GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) + +# If you need to override some of the declarations, place them in this file +# and uncomment this line. +#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt +DOC_OVERRIDES = + + +########################################################################### +# Everything below here is generic and you shouldn't need to change it. +########################################################################### -IGNORED_HEADER_FILES = \ - Executive-Summary.h - -scan_generated = \ - evolution-services-decl.txt \ - evolution-services.args \ - evolution-services.hierarchy \ - evolution-services.signals \ - evolution-services.types - -tmpl_dependencies = \ - evolution-services-decl.txt \ - evolution-services-sections.txt \ - evolution-services.args \ - evolution-services.hierarchy \ - evolution-services.signals - -tmpl_sources = \ - tmpl/evolution-services.sgml \ - tmpl/evolution-services-unused.sgml - -tmpl_generated = \ - evolution-services-unused.txt - -sgml_dependencies = \ - evolution-services-decl.txt \ - evolution-services-sections.txt \ - evolution-services.args \ - evolution-services.hierarchy \ - evolution-services.signals \ - tmpl/evolution-services.sgml - -sgml_generated = \ - sgml/evolution-services.sgml \ - sgml/evolution-services-doc.bottom \ - sgml/evolution-services-doc.top \ - sgml/object_index.sgml \ - sgml/tree_index.sgml - -EXTRA_DIST = \ - evolution-services.args \ - evolution-services.hierarchy \ - evolution-services.signals \ - evolution-services.types \ - evolution-services-decl.txt \ - evolution-services-sections.txt - -all: $(sgml_generated) +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_OVERRIDES) + +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 -scan $(scan_generated): $(SOURCE_FILES) - -(ln -sf $(srcdir)/$(DOC_MODULE).types . \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ - --ignore-headers="$(IGNORED_HEADER_FILES)" ) - -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) +#all-local: html-build.stamp +all-local: sgml-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-scanobj --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_OVERRIDES) + @echo '*** Rebuilding template files ***' cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + touch tmpl-build.stamp -sgml $(sgml_generated): $(sgml_dependencies) - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) -else -scan $(scan_generated): $(SOURCE_FILE) +tmpl.stamp: tmpl-build.stamp + @true -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) +#### sgml #### -sgml $(sgml_generated): $(sgml_dependencies) +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) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(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 ***' + test -d $(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 +############## + clean-local: - rm -f *~ *.bak *.signals *-unused.txt + rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt install-data-local: - $(mkinstalldirs) $(DOC_DIR) - for i in $(DOC_DIR_INSTALL_FILES); do \ - $(INSTALL_DATA) $(srcdir)/$$i $(DOC_DIR); \ - done + $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) + (installfiles=`echo $(srcdir)/html/*.html`; \ + if test "$$installfiles" = '$(srcdir)/html/*.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 +endif -dist-hook: - mkdir $(distdir)/sgml +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)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml + -cp $(srcdir)/html/index.sgml $(distdir)/html + -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html + + images=$(HTML_IMAGES) ; \ + for i in $$images ; do \ + cp $(srcdir)/$$i $(distdir)/html ; \ + done -.PHONY: scan templates sgml +.PHONY : dist-hook-local diff --git a/help/devel/importer/Makefile.am b/help/devel/importer/Makefile.am index 571d05e58a..8b5343677a 100644 --- a/help/devel/importer/Makefile.am +++ b/help/devel/importer/Makefile.am @@ -1,127 +1,195 @@ -# The name of the module. +## Process this file with automake to produce Makefile.in + +# The name of the module, e.g. 'glib'. DOC_MODULE=evolution-shell-importer -# The directory containing the source code +# The top-level SGML file. Change it if you want. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting functions and macros. DOC_SOURCE_DIR=$(EVOLUTION_DIR)/shell/importer -CFLAGS =" \ +# Extra options to supply to gtkdoc-scan. +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +MKDB_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. +FIXXREF_OPTIONS= + +# Used for dependencies. +HFILE_GLOB= \ + $(top_srcdir)/shell/importer/evolution-importer.h \ + $(top_srcdir)/shell/importer/evolution-importer-client.h + +CFILE_GLOB= \ + $(top_srcdir)/shell/importer/evolution-importer.c \ + $(top_srcdir)/shell/importer/evolution-importer-client.c + +# Header files to ignore when scanning. +IGNORE_HFILES= \ + GNOME_Evolution_Importer.h \ + importer.h + +# Images to copy into HTML directory. +HTML_IMAGES = + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +content_files = + +# Other files to distribute. +extra_files = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib +# contains GtkObjects/GObjects and you want to document signals and properties. +GTKDOC_CFLAGS = \ -I$(top_srcdir)/shell/importer \ -I$(top_srcdir)/shell \ -I$(top_srcdir) \ -I$(top_builddir) \ - $(BONOBO_VFS_GNOME_CFLAGS) \ - " + $(BONOBO_VFS_GNOME_CFLAGS) -LDFLAGS=" \ +GTKDOC_LIBS = \ $(BONOBO_VFS_GNOME_LIBS) \ - $(top_builddir)/shell/importer/.libs/libevolution-importer.a \ - " + $(top_builddir)/shell/importer/.libs/libevolution-importer.so -DOC_DIR=$(datadir)/gnome/html +GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) +GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) -DOC_DIR_INSTALL_FILES = \ - evolution-shell-importer.args \ - evolution-shell-importer.hierarchy \ - evolution-shell-importer.signals \ - evolution-shell-importer.types \ - evolution-shell-importer-decl.txt \ - evolution-shell-importer-sections.txt +# If you need to override some of the declarations, place them in this file +# and uncomment this line. +#DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt +DOC_OVERRIDES = -SOURCE_FILES = \ - $(top_srcdir)/shell/importer/evolution-importer.c \ - $(top_srcdir)/shell/importer/evolution-importer.h \ - $(top_srcdir)/shell/importer/evolution-importer-client.c \ - $(top_srcdir)/shell/importer/evolution-importer-client.h +########################################################################### +# Everything below here is generic and you shouldn't need to change it. +########################################################################### -IGNORED_HEADER_FILES = \ - GNOME_Evolution_Importer.h \ - importer.h +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_OVERRIDES) -scan_generated = \ - evolution-shell-importer-decl.txt \ - evolution-shell-importer.args \ - evolution-shell-importer.hierarchy \ - evolution-shell-importer.signals \ - evolution-shell-importer.types - -tmpl_dependencies = \ - evolution-shell-importer-decl.txt \ - evolution-shell-importer-sections.txt \ - evolution-shell-importer.args \ - evolution-shell-importer.hierarchy \ - evolution-shell-importer.signals - -tmpl_sources = \ - tmpl/evolution-importer.sgml \ - tmpl/evolution-shell-importer-unused.sgml - -tmpl_generated = \ - evolution-shell-importer-unused.txt - -sgml_dependencies = \ - evolution-shell-importer-decl.txt \ - evolution-shell-importer-sections.txt \ - evolution-shell-importer.args \ - evolution-shell-importer.hierarchy \ - evolution-shell-importer.signals \ - tmpl/evolution-importer.sgml - -sgml_generated = \ - sgml/evolution-importer.sgml \ - sgml/evolution-shell-importer-doc.bottom \ - sgml/evolution-shell-importer-doc.top \ - sgml/object_index.sgml \ - sgml/tree_index.sgml - -EXTRA_DIST = \ - evolution-shell-importer.args \ - evolution-shell-importer.hierarchy \ - evolution-shell-importer.signals \ - evolution-shell-importer.types \ - evolution-shell-importer-decl.txt \ - evolution-shell-importer-sections.txt - -all: $(sgml_generated) +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 -scan $(scan_generated): $(SOURCE_FILES) - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ - --ignore-headers="$(IGNORED_HEADER_FILES)" ) - -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) +#all-local: html-build.stamp +all-local: sgml-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-scanobj --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_OVERRIDES) + @echo '*** Rebuilding template files ***' cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + touch tmpl-build.stamp -sgml $(sgml_generated): $(sgml_dependencies) - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) -else -scan $(scan_generated): $(SOURCE_FILE) +tmpl.stamp: tmpl-build.stamp + @true -templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) +#### sgml #### -sgml $(sgml_generated): $(sgml_dependencies) +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) --main-sgml-file=$(DOC_MAIN_SGML_FILE) $(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 ***' + test -d $(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 +############## + clean-local: - rm -f *~ *.bak *.signals *-unused.txt + rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt + cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt install-data-local: - $(mkinstalldirs) $(DOC_DIR) - for i in $(DOC_DIR_INSTALL_FILES); do \ - $(INSTALL_DATA) $(srcdir)/$$i $(DOC_DIR); \ - done + $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) + (installfiles=`echo $(srcdir)/html/*.html`; \ + if test "$$installfiles" = '$(srcdir)/html/*.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 +endif -dist-hook: - mkdir $(distdir)/sgml +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)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml + -cp $(srcdir)/html/index.sgml $(distdir)/html + -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html + + images=$(HTML_IMAGES) ; \ + for i in $$images ; do \ + cp $(srcdir)/$$i $(distdir)/html ; \ + done + +.PHONY : dist-hook-local + -.PHONY: scan templates sgml |