docs/: Change to xinclude based build - its faster and easier to maintain.

Original commit message from CVS:
* docs/Makefile.am:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* docs/gst/running.xml:
* docs/libs/gstreamer-libs-docs.sgml:
Change to xinclude based build - its faster and easier to maintain.

diff --git a/ChangeLog b/ChangeLog
index c75dde0..35f450e 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
 2008-10-30  Stefan Kost  <ensonic@users.sf.net>
 
+       * docs/Makefile.am:
+       * docs/gst/gstreamer-docs.sgml:
+       * docs/gst/gstreamer-sections.txt:
+       * docs/gst/running.xml:
+       * docs/libs/gstreamer-libs-docs.sgml:
+         Change to xinclude based build - its faster and easier to maintain.
+
+2008-10-30  Stefan Kost  <ensonic@users.sf.net>
+
        * gst/gstregistrybinary.c:
        * gst/gstregistryxml.c:
          Use g_unlink() as none of these are directories.

diff --git a/common b/common
index 2802bb1..edfb4b4 160000 (submodule)
--- a/common
+++ b/common
@@ -1 +1 @@
-Subproject commit 2802bb17517a6cfbbb1be6da61ec19151be0750b
+Subproject commit edfb4b44ea433b0b83b8a2f27a6e0bcbccdc3f2f

diff --git a/docs/Makefile.am b/docs/Makefile.am
index b6116a8..27583ad 100644 (file)
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -25,3 +25,4 @@ EXTRA_DIST = \
 
 upload:
        @if test "x$(SUBDIRS)" != x; then for a in $(SUBDIRS); do cd $$a; make upload; cd ..; done; fi
+

diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index c6203c3..b7ae9f7 100644 (file)
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -1,67 +1,12 @@
 <?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
 <!ENTITY % version-entities SYSTEM "version.entities">
 %version-entities;
-<!ENTITY Gst SYSTEM "xml/gst.xml">
-<!ENTITY GstBin SYSTEM "xml/gstbin.xml">
-<!ENTITY GstBuffer SYSTEM "xml/gstbuffer.xml">
-<!ENTITY GstBus SYSTEM "xml/gstbus.xml">
-<!ENTITY GstCaps SYSTEM "xml/gstcaps.xml">
-<!ENTITY GstChildProxy SYSTEM "xml/gstchildproxy.xml">
-<!ENTITY GstClock SYSTEM "xml/gstclock.xml">
-<!--
-<!ENTITY GstCompat SYSTEM "xml/gstcompat.xml">
--->
-<!ENTITY GstConfig SYSTEM "xml/gstconfig.xml">
-<!ENTITY GstElement SYSTEM "xml/gstelement.xml">
-<!ENTITY GstElementFactory SYSTEM "xml/gstelementfactory.xml">
-<!ENTITY GstError SYSTEM "xml/gsterror.xml">
-<!ENTITY GstEvent SYSTEM "xml/gstevent.xml">
-<!ENTITY GstFilter SYSTEM "xml/gstfilter.xml">
-<!ENTITY GstFormat SYSTEM "xml/gstformat.xml">
-<!ENTITY GstGhostPad SYSTEM "xml/gstghostpad.xml">
-<!ENTITY GstImplementsInterface SYSTEM "xml/gstimplementsinterface.xml">
-<!ENTITY GstIndex SYSTEM "xml/gstindex.xml">
-<!ENTITY GstIndexFactory SYSTEM "xml/gstindexfactory.xml">
-<!ENTITY GstInfo SYSTEM "xml/gstinfo.xml">
-<!ENTITY GstIterator SYSTEM "xml/gstiterator.xml">
-<!ENTITY GstMessage SYSTEM "xml/gstmessage.xml">
-<!ENTITY GstMiniObject SYSTEM "xml/gstminiobject.xml">
-<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
-<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
-<!ENTITY GstPadTemplate SYSTEM "xml/gstpadtemplate.xml">
-<!ENTITY GstParamSpec SYSTEM "xml/gstparamspec.xml">
-<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
-<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
-<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
-<!ENTITY GstPluginFeature SYSTEM "xml/gstpluginfeature.xml">
-<!ENTITY GstPoll SYSTEM "xml/gstpoll.xml">
-<!ENTITY GstPreset SYSTEM "xml/gstpreset.xml">
-<!ENTITY GstQuery SYSTEM "xml/gstquery.xml">
-<!ENTITY GstRegistry SYSTEM "xml/gstregistry.xml">
-<!ENTITY GstSegment SYSTEM "xml/gstsegment.xml">
-<!ENTITY GstStructure SYSTEM "xml/gststructure.xml">
-<!ENTITY GstSystemClock SYSTEM "xml/gstsystemclock.xml">
-<!ENTITY GstTagList SYSTEM "xml/gsttaglist.xml">
-<!ENTITY GstTagSetter SYSTEM "xml/gsttagsetter.xml">
-<!ENTITY GstTask SYSTEM "xml/gsttask.xml">
-<!ENTITY GstTrace SYSTEM "xml/gsttrace.xml">
-<!ENTITY GstTypeFind SYSTEM "xml/gsttypefind.xml">
-<!ENTITY GstTypeFindFactory SYSTEM "xml/gsttypefindfactory.xml">
-<!ENTITY GstUriHandler SYSTEM "xml/gsturihandler.xml">
-<!ENTITY GstUtils SYSTEM "xml/gstutils.xml">
-<!ENTITY GstValue SYSTEM "xml/gstvalue.xml">
-<!ENTITY GstVersion SYSTEM "xml/gstversion.xml">
-<!ENTITY GstXML SYSTEM "xml/gstxml.xml">
-
-<!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.sgml">
-
-<!ENTITY gst-Running SYSTEM "running.xml">
-
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 <!ENTITY hash "#">
 ]>
-<book id="index">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
     <title>GStreamer &GST_MAJORMINOR; Core Reference Manual</title>
     <releaseinfo>
@@ -88,7 +33,7 @@ Windows.  It is released under the GNU Library General Public License
 (GNU LGPL).
     </para>
 
-    &gst-Running;
+    <xi:include href="running.xml" />
   </chapter>
 
   <chapter id="libgstreamer">
@@ -101,52 +46,52 @@ Windows.  It is released under the GNU Library General Public License
       along with some more specialized elements.
     </para>
 
-    &Gst;
-    &GstBin;
-    &GstBuffer;
-    &GstBus;
-    &GstCaps;
-    &GstChildProxy;
-    &GstClock;
-    &GstConfig;
-    &GstElement;
-    &GstElementFactory;
-    &GstError;
-    &GstEvent;
-    &GstFilter;
-    &GstFormat;
-    &GstGhostPad;
-    &GstImplementsInterface;
-    &GstIndex;
-    &GstIndexFactory;
-    &GstIterator;
-    &GstMessage;
-    &GstMiniObject;
-    &GstObject;
-    &GstPad;
-    &GstPadTemplate;
-    &GstParamSpec;
-    &GstParse;
-    &GstPipeline;
-    &GstPlugin;
-    &GstPluginFeature;
-    &GstPoll;
-    &GstPreset;
-    &GstQuery;
-    &GstRegistry;
-    &GstSegment;
-    &GstStructure;
-    &GstSystemClock;
-    &GstTagList;
-    &GstTagSetter;
-    &GstTask;
-    &GstTypeFind;
-    &GstTypeFindFactory;
-    &GstUriHandler;
-    &GstUtils;
-    &GstValue;
-    &GstVersion;
-    &GstXML;
+    <xi:include href="xml/gst.xml" />
+    <xi:include href="xml/gstbin.xml" />
+    <xi:include href="xml/gstbuffer.xml" />
+    <xi:include href="xml/gstbus.xml" />
+    <xi:include href="xml/gstcaps.xml" />
+    <xi:include href="xml/gstchildproxy.xml" />
+    <xi:include href="xml/gstclock.xml" />
+    <xi:include href="xml/gstconfig.xml" />
+    <xi:include href="xml/gstelement.xml" />
+    <xi:include href="xml/gstelementfactory.xml" />
+    <xi:include href="xml/gsterror.xml" />
+    <xi:include href="xml/gstevent.xml" />
+    <xi:include href="xml/gstfilter.xml" />
+    <xi:include href="xml/gstformat.xml" />
+    <xi:include href="xml/gstghostpad.xml" />
+    <xi:include href="xml/gstimplementsinterface.xml" />
+    <xi:include href="xml/gstindex.xml" />
+    <xi:include href="xml/gstindexfactory.xml" />
+    <xi:include href="xml/gstiterator.xml" />
+    <xi:include href="xml/gstmessage.xml" />
+    <xi:include href="xml/gstminiobject.xml" />
+    <xi:include href="xml/gstobject.xml" />
+    <xi:include href="xml/gstpad.xml" />
+    <xi:include href="xml/gstpadtemplate.xml" />
+    <xi:include href="xml/gstparamspec.xml" />
+    <xi:include href="xml/gstparse.xml" />
+    <xi:include href="xml/gstpipeline.xml" />
+    <xi:include href="xml/gstplugin.xml" />
+    <xi:include href="xml/gstpluginfeature.xml" />
+    <xi:include href="xml/gstpoll.xml" />
+    <xi:include href="xml/gstpreset.xml" />
+    <xi:include href="xml/gstquery.xml" />
+    <xi:include href="xml/gstregistry.xml" />
+    <xi:include href="xml/gstsegment.xml" />
+    <xi:include href="xml/gststructure.xml" />
+    <xi:include href="xml/gstsystemclock.xml" />
+    <xi:include href="xml/gsttaglist.xml" />
+    <xi:include href="xml/gsttagsetter.xml" />
+    <xi:include href="xml/gsttask.xml" />
+    <xi:include href="xml/gsttypefind.xml" />
+    <xi:include href="xml/gsttypefindfactory.xml" />
+    <xi:include href="xml/gsturihandler.xml" />
+    <xi:include href="xml/gstutils.xml" />
+    <xi:include href="xml/gstvalue.xml" />
+    <xi:include href="xml/gstversion.xml" />
+    <xi:include href="xml/gstxml.xml" />
 
   </chapter>
 
@@ -157,41 +102,23 @@ Windows.  It is released under the GNU Library General Public License
       Application developers will rarely need to know about it.
     </para>
 
-    &GstInfo;
-    &GstTrace;
-
-  </chapter>
-
-<!--
-  <chapter id="gstreamer-compat">
-    <title>GStreamer Core Compatibility</title>
-    <para>
-      These elements are defined for compatibility with older code.
-      They must not be used in new code!
-    </para>
-
-    &GstCompat;
+    <xi:include href="xml/gstinfo.xml" />
+    <xi:include href="xml/gsttrace.xml" />
 
   </chapter>
--->
 
   <chapter id="gstreamer-hierarchy">
     <title>Object Hierarchy</title>
-    &gstreamer-tree-index;
+    <xi:include href="xml/tree_index.sgml"/>
   </chapter>
 
-  <index id="api-index">
-    <title>Index</title>
-  </index>
-  <index role="deprecated">
-    <title>Index of deprecated symbols</title>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
   </index>
-  <!-- disable, as
-     - index generation is extremly slow in xslt
-     - we have not tagged lots of symbols this way anyway
-  <index role="0.9">
-    <title>Index of new symbols in 0.9</title>
+  <index id="api-index-deprecated" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
-  -->
 
 </book>

diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 0dbcebb..1907ac3 100644 (file)
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -1519,6 +1519,8 @@ gst_static_caps_get_type
 <TITLE>GstParamSpec</TITLE>
 
 GST_PARAM_CONTROLLABLE
+GST_PARAM_USER_EDITABLE
+GST_PARAM_NOT_PRESETABLE
 GST_PARAM_USER_SHIFT
 
 <SUBSECTION paramspecfraction>

diff --git a/docs/gst/running.xml b/docs/gst/running.xml
index 75655d7..7858e49 100644 (file)
--- a/docs/gst/running.xml
+++ b/docs/gst/running.xml
@@ -1,3 +1,10 @@
+<?xml version="1.0"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
 <refentry id="gst-running" revision="08 Oct 2005">
 <refmeta>
 <refentrytitle>Running GStreamer Applications</refentrytitle>

diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index 3daaa2d..b93e08f 100644 (file)
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -3,38 +3,10 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 <!ENTITY % version-entities SYSTEM "version.entities">
 %version-entities;
-
-<!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
-<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
-<!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
-<!ENTITY GstBaseTransform SYSTEM "xml/gstbasetransform.xml">
-<!ENTITY GstBitReader SYSTEM "xml/gstbitreader.xml">
-<!ENTITY GstByteReader SYSTEM "xml/gstbytereader.xml">
-<!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
-<!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
-<!ENTITY GstTypeFindHelper SYSTEM "xml/gsttypefindhelper.xml">
-<!ENTITY GstDataQueue SYSTEM "xml/gstdataqueue.xml">
-
-<!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">
-<!ENTITY GstCheckBufferStraw SYSTEM "xml/gstcheckbufferstraw.xml">
-
-<!ENTITY GstController SYSTEM "xml/gstcontroller.xml">
-<!ENTITY GstControlSource SYSTEM "xml/gstcontrolsource.xml">
-<!ENTITY GstInterpolationControlSource SYSTEM "xml/gstinterpolationcontrolsource.xml">
-<!ENTITY GstLFOControlSource SYSTEM "xml/gstlfocontrolsource.xml">
-<!ENTITY GstControllerGObject SYSTEM "xml/gstcontrollergobject.xml">
-<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
-
-<!ENTITY GstNetClientClock SYSTEM "xml/gstnetclientclock.xml">
-<!ENTITY GstNetTimePacket SYSTEM "xml/gstnettimepacket.xml">
-<!ENTITY GstNetTimeProvider SYSTEM "xml/gstnettimeprovider.xml">
-
-<!-- generated by gtkdoc-mkdb -->
-<!ENTITY gstreamer-libs-tree-index SYSTEM "xml/tree_index.sgml">
-
+<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 <!ENTITY hash "#">
 ]>
-<book id="index">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
     <title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
     <releaseinfo>
@@ -60,31 +32,36 @@
         by elements and utillity classes that are most useful for plugin developers.
       </para>
 
-      &GstBaseSrc;
-      &GstBaseSink;
-      &GstBaseTransform;
-      &GstPushSrc;
-
-      &GstAdapter;
-      &GstBitReader;
-      &GstByteReader;
-      &GstCollectPads;
-      &GstTypeFindHelper;
-      &GstDataQueue;
+      <xi:include href="xml/gstbasesrc.xml" />
+      <xi:include href="xml/gstbasesink.xml" />
+      <xi:include href="xml/gstbasetransform.xml" />
+      <xi:include href="xml/gstpushsrc.xml" />
+
+      <xi:include href="xml/gstadapter.xml" />
+      <xi:include href="xml/gstbitreader.xml" />
+      <xi:include href="xml/gstbytereader.xml" />
+      <xi:include href="xml/gstcollectpads.xml" />
+      <xi:include href="xml/gsttypefindhelper.xml" />
+      <xi:include href="xml/gstdataqueue.xml" />
     </chapter>
 
     <chapter id="gstreamer-control">
       <title>GStreamer Dynamic Parameter Control</title>
-      &GstController;
-      &GstControlSource;
-      &GstInterpolationControlSource;
-      &GstLFOControlSource;
-      &GstControllerGObject;
+      <para>
+        libgstcontroller-&GST_MAJORMINOR;.so provides functionality to animate
+        element properties over time.
+      </para>
+
+      <xi:include href="xml/gstcontroller.xml" />
+      <xi:include href="xml/gstcontrolsource.xml" />
+      <xi:include href="xml/gstinterpolationcontrolsource.xml" />
+      <xi:include href="xml/gstlfocontrolsource.xml" />
+      <xi:include href="xml/gstcontrollergobject.xml" />
     </chapter>
 
     <chapter id="gstreamer-dataprotocol">
       <title>GStreamer Data Protocol</title>
-      &GstDataProtocol;
+      <xi:include href="xml/gstdataprotocol.xml" />
     </chapter>
 
     <chapter id="gstreamer-net">
@@ -93,9 +70,9 @@
         libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
       </para>
 
-      &GstNetClientClock;
-      &GstNetTimePacket;
-      &GstNetTimeProvider;
+      <xi:include href="xml/gstnetclientclock.xml" />
+      <xi:include href="xml/gstnettimepacket.xml" />
+      <xi:include href="xml/gstnettimeprovider.xml" />
     </chapter>
 
     <chapter id="gstreamer-check">
@@ -105,31 +82,23 @@
         unit tests that use the check framework.
       </para>
 
-      &GstCheck;
-      &GstCheckBufferStraw;
+      <xi:include href="xml/gstcheck.xml" />
+      <xi:include href="xml/gstcheckbufferstraw.xml" />
     </chapter>
   </part>
 
-  <part id="gstreamer-libs-hierarchy">
+  <chapter id="gstreamer-hierarchy">
     <title>Object Hierarchy</title>
-    &gstreamer-libs-tree-index;
-  </part>
+    <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
 
-  <index id="api-index">
-    <title>Index</title>
-  </index>
-  <index role="deprecated">
-    <title>Index of deprecated symbols</title>
-  </index>
-  <!-- disable, as
-     - index generation is extremly slow in gtk-doc
-     - we have not tagged lots of symbols thsi way anyway
-  <index role="0.8">
-    <title>Index of new symbols in 0.8</title>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
   </index>
-  <index role="0.9">
-    <title>Index of new symbols in 0.9</title>
+  <index id="api-index-deprecated" role="deprecated">
+    <title>Index of deprecated API</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
-  -->
 
 </book>