From 086b7e44e7c0a45f925501584a164217e3b61fd5 Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Thu, 7 Jul 2005 16:41:21 +0000 Subject: [PATCH] copy extra content files; make plugins-base use gtk-doc.mak Original commit message from CVS: copy extra content files; make plugins-base use gtk-doc.mak --- Makefile.am | 26 ++-- common | 2 +- configure.ac | 4 + docs/libs/Makefile.am | 241 +----------------------------------- docs/libs/tmpl/gstcolorbalance.sgml | 9 -- docs/libs/tmpl/gstmixer.sgml | 6 + 6 files changed, 29 insertions(+), 259 deletions(-) diff --git a/Makefile.am b/Makefile.am index 9ac9f65..fe73f81 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,27 +1,34 @@ if USE_GCONFTOOL -GCONF_DIR = gconf +SUBDIRS_GCONF = gconf else -GCONF_DIR = +SUBDIRS_GCONF = endif if BUILD_EXTERNAL -EXT_DIR = ext +SUBDIRS_EXT = ext else -EXT_DIR = +SUBDIRS_EXT = endif if BUILD_EXAMPLES -EXAMPLES_DIR = examples +SUBDIRS_EXAMPLES = examples else -EXAMPLES_DIR = +SUBDIRS_EXAMPLES = +endif + +if HAVE_CHECK +SUBDIRS_CHECK = check +else +SUBDIRS_CHECK = endif SUBDIRS = \ gst-libs \ - gst sys $(EXT_DIR) \ - $(EXAMPLES_DIR) \ + gst sys $(SUBDIRS_EXT) \ + $(SUBDIRS_EXAMPLES) \ tools \ - $(GCONF_DIR) \ + $(SUBDIRS_GCONF) \ + $(SUBDIRS_CHECK) \ docs \ po \ common \ @@ -35,6 +42,7 @@ DIST_SUBDIRS = \ examples \ tools \ gconf \ + check \ po \ common \ m4 \ diff --git a/common b/common index 4ca96ae..03aa1cd 160000 --- a/common +++ b/common @@ -1 +1 @@ -Subproject commit 4ca96aedcf2be0b3dcf31fce732aed1da21b8850 +Subproject commit 03aa1cd7f77f87fc24565044c0a3c9c5124c39a4 diff --git a/configure.ac b/configure.ac index 922a27c..b078a8f 100644 --- a/configure.ac +++ b/configure.ac @@ -733,6 +733,9 @@ main() { atomic_t t; atomic_set(&t,0); atomic_inc(&t); atomic_add(1,&t);return 0 ]) fi +dnl check for "check", unit testing library/header +AM_PATH_CHECK(0.9.2, HAVE_CHECK=yes, HAVE_CHECK=no) +AM_CONDITIONAL(HAVE_CHECK, test "x$HAVE_CHECK" = "xyes") dnl ###################################################################### dnl # Check command line parameters, and set shell variables accordingly # @@ -933,6 +936,7 @@ pkgconfig/gstreamer-gconf.pc pkgconfig/gstreamer-gconf-uninstalled.pc pkgconfig/gstreamer-plugins-base.pc pkgconfig/gstreamer-plugins-base-uninstalled.pc +check/Makefile docs/Makefile docs/libs/Makefile docs/version.entities diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index 9a65ec0..d2f025f 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -92,243 +92,4 @@ GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) # and uncomment this line. #DOC_OVERRIDES = $(DOC_MODULE)-overrides.txt - - -########################################################################### -# Everything below here is generic and you shouldn't need to change it. -########################################################################### -# thomas: except of course that we did - -# thomas: copied from glib-2 -# 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)-@GST_MAJORMINOR@ - -EXTRA_DIST = \ - $(content_files) \ - $(extra_files) \ - $(HTML_IMAGES) \ - $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE).types \ - $(DOC_MODULE)-sections.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).interfaces \ - $(DOC_MODULE).prerequisites \ - .libs/$(DOC_MODULE)-scan.o \ - $(DOC_MODULE).signals - -CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS) - -if HAVE_GTK_DOC -all-local: html-build.stamp - -#### scan #### - -# in the case of non-srcdir builds, the built gst directory gets added -# to gtk-doc scanning; but only then, to avoid duplicates -scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles) - @echo '*** Scanning header files ***' - if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null; \ - then \ - if test x"$(srcdir)" != x. ; then \ - cp $(srcdir)/$(DOC_MODULE).types . ; \ - chmod u+w $(DOC_MODULE).types ; \ - fi ; \ - GST_PLUGIN_PATH_ONLY=yes GST_PLUGIN_PATH="$(top_builddir)" \ - CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" \ - CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" \ - $(GTK_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" \ - --module=$(DOC_MODULE) ; \ - else \ - cd $(srcdir) ; \ - for i in $(SCANOBJ_FILES) ; do \ - test -f $$i || touch $$i ; \ - done \ - fi - if test "x$(top_srcdir)" != "x$(top_builddir)"; \ - then \ - export BUILT_OPTIONS="--source-dir=$(top_builddir)/libs/gst"; \ - fi; \ - gtkdoc-scan \ - $(SCAN_OPTIONS) $(EXTRA_HFILES) \ - --module=$(DOC_MODULE) \ - --source-dir=$(DOC_SOURCE_DIR) \ - $$BUILT_OPTIONS \ - --ignore-headers="$(IGNORE_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 ***' - if test x"$(srcdir)" != x. ; then \ - cp $(srcdir)/$(DOC_MODULE)-decl.txt . ; \ - cp $(srcdir)/$(DOC_MODULE)-sections.txt . ; \ - fi - gtkdoc-mktmpl --module=$(DOC_MODULE) - touch tmpl-build.stamp - -tmpl.stamp: tmpl-build.stamp - @true - -#### sgml #### - -sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) - @echo '*** Building XML ***' - 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 - @if grep "WARNING:" sgml-build.log > /dev/null; then exit 1; fi - rm sgml-build.log - touch sgml-build.stamp - -sgml.stamp: sgml-build.stamp - @true - -#### html #### - -# FIXME: setting LANG=C is a hack to work with gtk-doc < 1.1, because -# that forces a non-utf8 locale. gtk-doc >= 1.1 solves this by calling -# use bytes; in gtkdoc-fixxref -html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo '*** Building HTML ***' - if test -d html; then rm -rf html; fi - mkdir html - @cp $(srcdir)/$(DOC_MAIN_SGML_FILE) html - @for f in $(content_files); do cp $(srcdir)/$$f html; done - cp -pr xml html - cp ../version.entities html - cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) - rm -f html/$(DOC_MAIN_SGML_FILE) - rm -rf html/xml - rm -f html/version.entities - test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \ - if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done - @echo '-- Fixing Crossreferences' - LANG=C && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - touch html-build.stamp -else -all-local: -endif - -clean-local: - rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) - rm -rf xml html - -maintainer-clean-local: clean - cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt - -# FIXME : thomas added all sgml files and some other things to make -# make distcheck work -distclean-local: clean - rm -rf $(DOC_MODULE)-decl-list.txt - rm -rf $(DOC_MODULE)-decl.txt - rm -rf $(DOC_MODULE)-undocumented.txt - rm -rf $(DOC_MODULE)-unused.txt - rm -rf tmpl/*.sgml.bak - rm -f $(DOC_MODULE).hierarchy - rm -f *.stamp || true - if test x"$(srcdir)" != x. ; then \ - rm -f $(DOC_MODULE)-docs.sgml ; \ - rm -f $(DOC_MODULE).types ; \ - rm -f $(DOC_MODULE).interfaces ; \ - rm -f $(DOC_MODULE).prerequisites ; \ - rm -f $(DOC_MODULE)-sections.txt ; \ - rm -rf tmpl/*.sgml ; \ - fi - rm -f *.o - - -install-data-local: - $(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) - (installfiles=`echo ./html/*.html`; \ - if test "$$installfiles" = './html/*.html'; \ - then echo '-- Nothing to install' ; \ - else \ - for i in $$installfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - pngfiles=`echo ./html/*.png`; \ - if test "$$pngfiles" != './html/*.png'; then \ - for i in $$pngfiles; do \ - echo '-- Installing '$$i ; \ - $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR); \ - done; \ - fi; \ - echo '-- Installing $(srcdir)/html/$(DOC_MODULE).devhelp' ; \ - $(INSTALL_DATA) $(srcdir)/html/$(DOC_MODULE).devhelp \ - $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \ - echo '-- Installing $(srcdir)/html/index.sgml' ; \ - $(INSTALL_DATA) $(srcdir)/html/index.sgml $(DESTDIR)$(TARGET_DIR); \ - fi) -uninstall-local: - (installfiles=`echo ./html/*.html`; \ - if test "$$installfiles" = './html/*.html'; \ - then echo '-- Nothing to uninstall' ; \ - else \ - for i in $$installfiles; do \ - rmfile=`basename $$i` ; \ - echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \ - done; \ - pngfiles=`echo ./html/*.png`; \ - if test "$$pngfiles" != './html/*.png'; then \ - for i in $$pngfiles; do \ - rmfile=`basename $$i` ; \ - echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/'$$rmfile ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/$$rmfile; \ - done; \ - fi; \ - echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE).devhelp' ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/$(DOC_MODULE)-@GST_MAJORMINOR@.devhelp; \ - echo '-- Uninstalling $(DESTDIR)$(TARGET_DIR)/index.sgml' ; \ - rm -f $(DESTDIR)$(TARGET_DIR)/index.sgml; \ - fi) - if test -d $(DESTDIR)$(TARGET_DIR); then rmdir -p --ignore-fail-on-non-empty $(DESTDIR)$(TARGET_DIR) 2>/dev/null; fi - -# -# Require gtk-doc when making dist -# -if HAVE_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-check-gtkdoc dist-hook-local - mkdir $(distdir)/tmpl - mkdir $(distdir)/xml - mkdir $(distdir)/html - -cp $(srcdir)/tmpl/*.sgml $(distdir)/tmpl - -cp $(srcdir)/sgml/*.xml $(distdir)/xml - -cp $(srcdir)/html/index.sgml $(distdir)/html - -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - -cp $(srcdir)/html/gstreamer-libs.devhelp $(distdir)/html - - images=$(HTML_IMAGES) ; \ - for i in "" $$images ; do \ - if test "$$i" != ""; then cp $(srcdir)/$$i $(distdir)/html ; fi; \ - done - -.PHONY : dist-hook-local +include $(top_srcdir)/common/gtk-doc.mak diff --git a/docs/libs/tmpl/gstcolorbalance.sgml b/docs/libs/tmpl/gstcolorbalance.sgml index 5953b69..3d401d8 100644 --- a/docs/libs/tmpl/gstcolorbalance.sgml +++ b/docs/libs/tmpl/gstcolorbalance.sgml @@ -20,15 +20,6 @@ interface for elements that provide color balance operations - - - - - -@gstcolorbalance: the object which received the signal. -@arg1: -@arg2: - diff --git a/docs/libs/tmpl/gstmixer.sgml b/docs/libs/tmpl/gstmixer.sgml index da7e32d..a70333a 100644 --- a/docs/libs/tmpl/gstmixer.sgml +++ b/docs/libs/tmpl/gstmixer.sgml @@ -45,12 +45,18 @@ gstmixer +@parent: +@values: +@_gst_reserved: +@parent: +@label: +@flags: -- 2.7.4