only scanobj stuff from our source module. Not sure yet if that's correct, given...

Original commit message from CVS:

* common/gstdoc-scangobj:
* common/gtk-doc-plugins.mak:
* docs/libs/Makefile.am:
* docs/plugins/gst-plugins-base-plugins.args:
* docs/plugins/gst-plugins-base-plugins.hierarchy:
* docs/plugins/gst-plugins-base-plugins.interfaces:
* docs/plugins/gst-plugins-base-plugins.prerequisites:
* docs/plugins/gst-plugins-base-plugins.signals:
only scanobj stuff from our source module.  Not sure yet
if that's correct, given the hierarchy stuff :)

diff --git a/gstdoc-scangobj b/gstdoc-scangobj
index d6e1560..e6b5b98 100755 (executable)
--- a/gstdoc-scangobj
+++ b/gstdoc-scangobj
@@ -44,6 +44,7 @@ my $TYPE_INIT_FUNC="g_type_init ()";
 
 # --nogtkinit is deprecated, as it is the default now anyway.
 %optctl = (module => \$MODULE,
+           source => \$SOURCE,
           types => \$TYPES_FILE,
           nogtkinit => \$NO_GTK_INIT,
           'type-init-func' => \$TYPE_INIT_FUNC,
@@ -51,7 +52,7 @@ my $TYPE_INIT_FUNC="g_type_init ()";
           'version' => \$PRINT_VERSION,
           'help' => \$PRINT_HELP);
           
-GetOptions(\%optctl, "module=s", "types:s", "output-dir:s", "nogtkinit", "type-init-func:s", "version", "help");
+GetOptions(\%optctl, "module=s", "source=s", "types:s", "output-dir:s", "nogtkinit", "type-init-func:s", "version", "help");
 
 if ($NO_GTK_INIT) {
   # Do nothing. This just avoids a warning.
@@ -67,8 +68,9 @@ if (!$MODULE) {
 }
 
 if ($PRINT_HELP) {
-    print "gtkdoc-scangobj version 1.3\n";
+    print "gstdoc-scangobj version 1.3\n";
     print "\n--module=MODULE_NAME  Name of the doc module being parsed";
+    print "\n--source=SOURCE_NAME  Name of the source module for plugins";
     print "\n--types=FILE          The name of the file to store the types in";
     print "\n--type-init-func=FUNC The init function to call instead of g_type_init ()";
     print "\n--output-dir=DIRNAME  The directory where the results are stored";
@@ -147,6 +149,9 @@ get_object_types (void)
 
       plugin = (GstPlugin *) (plugins->data);
       plugins = g_list_next (plugins);
+      if (strcmp (gst_plugin_get_source (plugin), "$SOURCE") != 0) {
+        continue;
+      }
 
       features = gst_plugin_get_feature_list (plugin);
       while (features) {

diff --git a/gtk-doc-plugins.mak b/gtk-doc-plugins.mak
index faa63ff..d7dc4fd 100644 (file)
--- a/gtk-doc-plugins.mak
+++ b/gtk-doc-plugins.mak
@@ -1,6 +1,15 @@
 # This is an include file specifically tuned for building documentation
 # for GStreamer plug-ins
 
+help:
+       @echo "If you are a doc maintainer, run 'make update' to update"
+       @echo "the documentation files maintained in CVS"
+
+# update the stuff maintained by doc maintainers
+update:
+       make inspect-update
+       make scanobj-update
+
 # 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
@@ -26,6 +35,11 @@ EXTRA_DIST =                                 \
        $(DOC_OVERRIDES)                \
        $(DOC_MODULE)-sections.txt
 
+MAINTAINER_DOC_STAMPS =                        \
+       scanobj-build.stamp             \
+       inspect-build.stamp             \
+       inspect.stamp
+
 # we don't add inspect-build.stamp and scanobj-build.stamp here since they are
 # built manually by docs maintainers and result is commited to CVS
 DOC_STAMPS =                           \
@@ -57,14 +71,13 @@ SCAN_FILES =                                \
        $(DOC_MODULE)-decl.txt          \
        $(DOC_MODULE)-decl-list.txt
 
-# FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
-# no idea why FC4 can do without
-CLEANFILES = $(SCANOBJ_FILES_O) $(DOC_MODULE)-unused.txt $(DOC_STAMPS) $(DOC_MODULE)-scan.c
-
 if ENABLE_GTK_DOC
 all-local: html-build.stamp
 
 #### scan gobjects; done by documentation maintainer ####
+scanobj-update:
+       -rm scanobj-build.stamp
+       make scanobj-build.stamp
 
 # in the case of non-srcdir builds, the built gst directory gets added
 # to gtk-doc scanning; but only then, to avoid duplicates
@@ -86,7 +99,7 @@ scanobj-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
            CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)"                         \
            CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)"          \
            $(GST_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)"   \
-               --module=$(DOC_MODULE) ;                                \
+               --module=$(DOC_MODULE) --source=$(PACKAGE);                             \
        fi
        touch scanobj-build.stamp
 
@@ -210,23 +223,30 @@ else
 all-local:
 endif
 
+# FC3 seems to need -scan.c to be part of CLEANFILES for distcheck
+# no idea why FC4 can do without
+CLEANFILES = \
+       $(SCANOBJ_FILES_O) \
+       $(DOC_MODULE)-scan.c \
+       $(DOC_MODULE)-unused.txt \
+       $(DOC_STAMPS) \
+       inspect-registry.xml
+
 # FIXME: these rules need a little cleaning up
 clean-local:
        rm -f *~ *.bak
        rm -rf .libs
+# clean files generated for tmpl build
+       -rm -rf tmpl
 # clean files copied/generated for nonsrcdir tmpl build
        if test x"$(srcdir)" != x. ; then \
-           rm -rf $(SCANOBJ_FILES) $(SCAN_FILES)                       \
-               tmpl;                                                   \
+           rm -rf $(SCANOBJ_FILES) $(SCAN_FILES);                      \
        fi
 # clean files generated for xml build
        -rm -rf xml
 # clean files generate for html build
        -rm -rf html
 
-maintainer-clean-local: clean
-       cd $(srcdir) && rm -rf xml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
-
 distclean-local: clean
        rm -rf tmpl/*.sgml.bak
        rm -f *.stamp || true