Merge branch 'master' into 0.11
authorWim Taymans <wim.taymans@collabora.co.uk>
Tue, 7 Dec 2010 14:53:56 +0000 (15:53 +0100)
committerWim Taymans <wim.taymans@collabora.co.uk>
Tue, 7 Dec 2010 14:53:56 +0000 (15:53 +0100)
docs/random/ensonic/plugindocs.txt [new file with mode: 0644]
gst/gstplugin.c
libs/gst/base/Makefile.am
libs/gst/check/Makefile.am
libs/gst/net/Makefile.am

diff --git a/docs/random/ensonic/plugindocs.txt b/docs/random/ensonic/plugindocs.txt
new file mode 100644 (file)
index 0000000..3317eb7
--- /dev/null
@@ -0,0 +1,51 @@
+Plugin Docs
+===========
+
+In contrast to normal gtk-doc workflow modules will include
+common/gtk-doc-plugins.mak. This provides an additional 'make udpate' target.
+
+the "make update" target calls
+1.) common/gstdoc-scangobj --type-init-func="gst_init(NULL,NULL)" --module=$(DOC_MODULE) --source=$(PACKAGE)
+    common/scangobj-merge.py $(DOC_MODULE)
+
+the "tmpl" target is modified to run this extra step after "gtkdoc-mktmpl":
+2.) common/mangle-tmpl.py $(srcdir)/inspect tmpl
+
+and the "sgml" target is modified to run this step before "gtkdoc-mkdb":
+3.) for a in $(srcdir)/inspect/*.xml; do \
+  xsltproc --stringparam module $(MODULE) $(top_srcdir)/common/plugins.xsl $$a > xml/`basename $$a`;
+done
+
+Details
+=======
+
+1a.) gstdoc-scangobj
+-------------------
+- get types from registry instead of .types file
+- outputs inspect/plugin-<pluginname>.xml files
+- outputs signal and args files
+
+1b.) scangobj-merge.py
+---------------------
+- parse, update and write .signals and .args files
+
+2.) mangle-tmpl.py
+------------------
+- read data from inspect/plugin-<pluginname>.xml
+- insert/overwrite "Short Description" and "Long Description" in tmpl/
+- the "Long Description" contains a <xi:inlcude> for xml/element-<name>-details.xml
+
+3.) common/plugins.xsl
+----------------------
+- creates xml/plugin-<name>.xml and xml/element-<name>-details.xml
+
+
+TODO:
+-----
+- scangobj-merge.py -> gstdoc-scangobj
+- need a way to skip the tmpl step
+  - gtkdoc-mkdb needs a way to insert extra content
+  - maybe patch generated xml/*.xml files
+    - could common/plugins.xsl patch the files?
+      <refsect1 id="gstreamer-plugins-capsfilter.description" role="desc">
+
index 7799dfa..cedcc7a 100644 (file)
@@ -570,7 +570,8 @@ _gst_plugin_fault_handler_sighandler (int signum)
       g_print ("%s\n\n", _gst_plugin_fault_handler_filename);
       g_print ("Please either:\n");
       g_print ("- remove it and restart.\n");
-      g_print ("- run with --gst-disable-segtrap and debug.\n");
+      g_print
+          ("- run with --gst-disable-segtrap --gst-disable-registry-fork and debug.\n");
       exit (-1);
       break;
     default:
index 41d5e19..4ba90e9 100644 (file)
@@ -60,6 +60,7 @@ GstBase-@GST_MAJORMINOR@.gir: $(INTROSPECTION_SCANNER) libgstbase-@GST_MAJORMINO
                --nsversion=@GST_MAJORMINOR@ \
                --strip-prefix=Gst \
                -I$(top_srcdir) \
+               -I$(top_srcdir)/libs \
                $(gir_cincludes) \
                --add-include-path=$(top_builddir)/gst \
                --library=libgstbase-0.11.la \
index b477c9b..0040ba5 100644 (file)
@@ -120,6 +120,7 @@ GstCheck-@GST_MAJORMINOR@.gir: $(INTROSPECTION_SCANNER) libgstcheck-@GST_MAJORMI
                --nsversion=@GST_MAJORMINOR@ \
                --strip-prefix=Gst \
                -I$(top_srcdir) \
+               -I$(top_srcdir)/libs \
                $(gir_cincludes) \
                --add-include-path=$(top_builddir)/gst \
                --library=libgstcheck-0.11.la \
index b42ccea..87dfcef 100644 (file)
@@ -36,6 +36,7 @@ GstNet-@GST_MAJORMINOR@.gir: $(INTROSPECTION_SCANNER) libgstnet-@GST_MAJORMINOR@
                --strip-prefix=Gst \
                --nsversion=@GST_MAJORMINOR@ \
                -I$(top_srcdir) \
+               -I$(top_srcdir)/libs \
                $(gir_cincludes) \
                --add-include-path=$(top_builddir)/gst \
                --library=libgstnet-@GST_MAJORMINOR@.la \