updating docs build

Original commit message from CVS:
updating docs build

ChangeLog

@@ -1,3 +1,21 @@
+2005-09-03  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+	* Makefile.am:
+	* autogen.sh:
+	* common/gst-xmlinspect.py:
+	* configure.ac:
+	* docs/Makefile.am:
+	* docs/plugins/inspect/plugin-alsa.xml:
+	* docs/plugins/inspect/plugin-audioresample.xml:
+	* docs/plugins/inspect/plugin-ffmpegcolorspace.xml:
+	* docs/plugins/inspect/plugin-ogg.xml:
+	* docs/plugins/tmpl/element-gnomevfssink.sgml:
+	* docs/plugins/tmpl/element-multifdsink.sgml:
+	* docs/plugins/tmpl/element-tcpserversink.sgml:
+	* docs/plugins/tmpl/element-vorbisenc.sgml:
+	* gst-plugins-base.spec.in:
+	  various doc-related updates
+
 2005-08-31  Wim Taymans  <wim@fluendo.com>
 
 	* gst-libs/gst/audio/gstbaseaudiosink.c:

Makefile.am

@@ -1,3 +1,5 @@
+DISTCHECK_CONFIGURE_OPTIONS = --enable-gtk-doc
+
 if BUILD_EXTERNAL
 SUBDIRS_EXT = ext
 else

autogen.sh

@@ -25,7 +25,7 @@ then
 fi
 . common/gst-autogen.sh
 
-CONFIGURE_DEF_OPT='--enable-maintainer-mode --enable-plugin-builddir --enable-debug --enable-DEBUG --enable-gtk-doc'
+CONFIGURE_DEF_OPT='--enable-maintainer-mode --enable-gtk-doc'
 
 autogen_options $@
 

common

@@ -1 +1 @@
-Subproject commit 6fa4feccd5953a16dcf78f4c2bb3eca8040114ba
+Subproject commit ddbcaa275c5f41f19d5665f0c52de1f9edcb4689

configure.ac

@@ -28,7 +28,6 @@ dnl - library source changed -> increment REVISION
 dnl - interfaces added/removed/changed -> increment CURRENT, REVISION = 0
 dnl - interfaces added -> increment AGE
 dnl - interfaces removed -> AGE = 0
-dnl for 0.8.3 release, gst_play_get_all_by_interface was added, so update
 AS_LIBTOOL(GST_PLUGINS, 1, 0, 1)
 AS_LIBTOOL_TAGS([])
 AM_PROG_LIBTOOL
@@ -175,7 +174,6 @@ AC_ARG_WITH(pkg-config-path,
    AC_HELP_STRING([--with-pkg-config-path],[colon-separated list of pkg-config(1) dirs]),
    [export PKG_CONFIG_PATH=${withval}])
 
-GST_DOC()
 dnl check architecture
 GST_ARCH()
 
@@ -728,11 +726,12 @@ if test "x$USE_DEBUG" = xyes; then
   GST_CFLAGS="$GST_CFLAGS -g"
 fi
 
-dnl ######################
+dnl ############################
-dnl # Checks for gtk-doc #
+dnl # Checks for documentation #
-dnl ######################
+dnl ############################
 
 GTK_DOC_CHECK([1.3])
+AS_PATH_PYTHON([2.1])
 
 dnl #############################
 dnl # Set automake conditionals #

docs/Makefile.am

@@ -1,5 +1,5 @@
 if ENABLE_GTK_DOC
-GTK_DOC_DIRS = libs # plugins
+GTK_DOC_DIRS = libs plugins
 else
 GTK_DOC_DIRS =
 endif
@@ -11,5 +11,5 @@ EXTRA_DIST = \
         upload.mak \
         version.entities.in
 
-#upload:
+upload:
-#	@if test "x$(SUBDIRS_DOCS)" != x; then for a in $(SUBDIRS_DOCS); do cd $$a; make upload; cd ..; done; fi
+	@if test "x$(SUBDIRS_DOCS)" != x; then for a in $(SUBDIRS_DOCS); do cd $$a; make upload; cd ..; done; fi

docs/plugins/inspect/plugin-alsa.xml

@@ -8,6 +8,13 @@
   <package>GStreamer CVS/prerelease</package>
   <origin>http://gstreamer.freedesktop.org/</origin>
   <elements>
+    <element>
+      <name>alsamixer</name>
+      <longname>Alsa Mixer</longname>
+      <class>Generic/Audio</class>
+      <description>Control sound input and output levels with ALSA</description>
+      <author>Leif Johnson &lt;leif@ambient.2y.net&gt;</author>
+    </element>
     <element>
       <name>alsasink</name>
       <longname>Audio Sink (ALSA)</longname>

docs/plugins/inspect/plugin-audioresample.xml

@@ -0,0 +1,19 @@
+<plugin>
+  <name>audioresample</name>
+  <description>Resamples audio</description>
+  <filename>../../gst/audioresample/.libs/libgstaudioresample.so</filename>
+  <basename>libgstaudioresample.so</basename>
+  <version>0.9.1.1</version>
+  <license>LGPL</license>
+  <package>GStreamer CVS/prerelease</package>
+  <origin>http://gstreamer.freedesktop.org/</origin>
+  <elements>
+    <element>
+      <name>audioresample</name>
+      <longname>Audio scaler</longname>
+      <class>Filter/Converter/Audio</class>
+      <description>Resample audio</description>
+      <author>David Schleef &lt;ds@schleef.org&gt;</author>
+    </element>
+  </elements>
+</plugin>

docs/plugins/inspect/plugin-ffmpegcolorspace.xml

@@ -0,0 +1,19 @@
+<plugin>
+  <name>ffmpegcolorspace</name>
+  <description>colorspace conversion copied from FFMpeg</description>
+  <filename>../../gst/ffmpegcolorspace/.libs/libgstffmpegcolorspace.so</filename>
+  <basename>libgstffmpegcolorspace.so</basename>
+  <version>0.4.9-pre1</version>
+  <license>LGPL</license>
+  <package>FFMpeg</package>
+  <origin>http://ffmpeg.sourceforge.net/</origin>
+  <elements>
+    <element>
+      <name>ffmpegcolorspace</name>
+      <longname>FFMPEG Colorspace converter</longname>
+      <class>Filter/Converter/Video</class>
+      <description>Converts video from one colorspace to another</description>
+      <author>Ronald Bultje &lt;rbultje@ronald.bitfreak.net&gt;</author>
+    </element>
+  </elements>
+</plugin>

docs/plugins/inspect/plugin-ogg.xml

@@ -22,6 +22,13 @@
       <description>mux ogg streams (info about ogg: http://xiph.org)</description>
       <author>Wim Taymans &lt;wim@fluendo.com&gt;</author>
     </element>
+    <element>
+      <name>oggparse</name>
+      <longname>ogg parser</longname>
+      <class>Codec/Parser</class>
+      <description>parse ogg streams into pages (info about ogg: http://xiph.org)</description>
+      <author>Michael Smith &lt;msmith@fluendo.com&gt;</author>
+    </element>
     <element>
       <name>ogmaudioparse</name>
       <longname>OGM audio stream parser</longname>

docs/plugins/tmpl/element-gnomevfssink.sgml

@@ -9,12 +9,12 @@ gnomevfssink
 <para>
 
 </para>
+
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
-
 <!-- ##### SECTION Stability_Level ##### -->
 
 

docs/plugins/tmpl/element-multifdsink.sgml

@@ -9,12 +9,12 @@ Send data to multiple filedescriptors
 <para>
 
 </para>
+
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
-
 <!-- ##### SECTION Stability_Level ##### -->
 
 

docs/plugins/tmpl/element-tcpserversink.sgml

@@ -9,6 +9,8 @@ Send data as a server over the network via TCP
 <para>
 
 </para>
+
+
 <!-- ##### SECTION See_Also ##### -->
 <para>
 

docs/plugins/tmpl/element-vorbisenc.sgml

@@ -9,12 +9,12 @@ Encodes audio in Vorbis format
 <para>
 
 </para>
+
 <!-- ##### SECTION See_Also ##### -->
 <para>
 
 </para>
 
-
 <!-- ##### SECTION Stability_Level ##### -->
 
 

gst-plugins-base.spec.in

@@ -23,6 +23,7 @@ Requires(post):   %{gstregister}
 Requires(postun): %{gstregister}
 
 BuildRequires:  gcc-c++
+BuildRequires:  gtk-doc >= 1.3
 BuildRequires:  XFree86-devel
 
 @USE_GNOME_VFS_TRUE@Requires:      gnome-vfs2 > 1.9.4.00
@@ -46,8 +47,7 @@ plug-ins.
 %setup -q -n gst-plugins-base-%{version}
 %build
 %configure \
-  --enable-debug \
+  --enable-gtk-doc
-  --enable-DEBUG 
 
 make %{?_smp_mflags}
                                                                                 
@@ -93,7 +93,7 @@ rm -rf $RPM_BUILD_ROOT
 %{_libdir}/libgstnet-%{majorminor}.so.*
 %{_libdir}/libgstrtp-%{majorminor}.so.*
 
-# non-core plugins without external dependencies
+# base plugins without external dependencies
 %{_libdir}/gstreamer-%{majorminor}/libgstadder.so
 %{_libdir}/gstreamer-%{majorminor}/libgstaudioconvert.so
 %{_libdir}/gstreamer-%{majorminor}/libgstffmpegcolorspace.so
@@ -111,13 +111,38 @@ rm -rf $RPM_BUILD_ROOT
 %{_libdir}/gstreamer-%{majorminor}/libgstvideo4linux.so
 %{_libdir}/gstreamer-%{majorminor}/libgstaudioresample.so
 
+# Here are packages not in the base plugins package but not dependant
+# on an external lib
+
+### VIDEO 4 LINUX 2 ###
+# @USE_GST_V4L2_TRUE@%package -n gstreamer-plugins-v4l2
+# @USE_GST_V4L2_TRUE@Summary:       GStreamer Video for Linux 2 plug-in
+# @USE_GST_V4L2_TRUE@Group:         Applications/Multimedia
+# @USE_GST_V4L2_TRUE@Requires:      gstreamer-plugins09 = %{version}
+# @USE_GST_V4L2_TRUE@BuildRequires: glibc-devel
+# @USE_GST_V4L2_TRUE@Obsoletes:	  gstreamer-v4l2
+# @USE_GST_V4L2_TRUE@
+# @USE_GST_V4L2_TRUE@%description -n gstreamer-plugins-v4l2
+# @USE_GST_V4L2_TRUE@Plug-in for accessing Video for Linux devices.
+# @USE_GST_V4L2_TRUE@
+# @USE_GST_V4L2_TRUE@%files -n gstreamer-plugins-v4l2
+# @USE_GST_V4L2_TRUE@%defattr(-, root, root)
+# @USE_GST_V4L2_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstvideo4linux2.so
+# @USE_GST_V4L2_TRUE@
+# @USE_GST_V4L2_TRUE@%post -n gstreamer-plugins-v4l2
+# @USE_GST_V4L2_TRUE@%{register}
+# @USE_GST_V4L2_TRUE@
+# @USE_GST_V4L2_TRUE@%postun -n gstreamer-plugins-v4l2
+# @USE_GST_V4L2_TRUE@%{register}
+
+# base plugins with dependencies
+@USE_ALSA_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstalsa.so
 @USE_THEORA_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgsttheora.so
 @USE_GNOME_VFS_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstgnomevfs.so
 @USE_VORBIS_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstvorbis.so
 @USE_VORBIS_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstogg.so
 @USE_XVIDEO_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstximage.so
 @USE_XVIDEO_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstxvimagesink.so
-
                                                                                 
 %package devel
 Summary: 	GStreamer Plugin Library Headers
@@ -156,13 +181,13 @@ GStreamer Plugins Base library development and header files.
 %{_includedir}/gstreamer-%{majorminor}/gst/audio/multichannel-enumtypes.h
 %{_includedir}/gstreamer-%{majorminor}/gst/rtp/gstbasertpdepayload.h
 %{_includedir}/gstreamer-%{majorminor}/gst/rtp/gstrtpbuffer.h
-
-# plugin interface headers
 %{_includedir}/gstreamer-%{majorminor}/gst/audio/gstaudioclock.h
 %{_includedir}/gstreamer-%{majorminor}/gst/audio/gstaudiosink.h
 %{_includedir}/gstreamer-%{majorminor}/gst/audio/gstbaseaudiosink.h
 %{_includedir}/gstreamer-%{majorminor}/gst/audio/gstringbuffer.h
 %{_includedir}/gstreamer-%{majorminor}/gst/net/gstnetbuffer.h
+%{_includedir}/gstreamer-%{majorminor}/gst/tag/tag.h
+
 %{_libdir}/libgstaudio-%{majorminor}.so
 %{_libdir}/libgstaudiofilter-%{majorminor}.so
 %{_libdir}/libgstriff-%{majorminor}.so
@@ -170,40 +195,14 @@ GStreamer Plugins Base library development and header files.
 %{_libdir}/libgstvideo-%{majorminor}.so
 %{_libdir}/libgstnet-%{majorminor}.so
 %{_libdir}/libgstrtp-%{majorminor}.so
+%{_libdir}/libgstinterfaces-%{majorminor}.so
 
-
-# library headers
-%{_includedir}/gstreamer-%{majorminor}/gst/tag/tag.h
 # pkg-config files
 %{_libdir}/pkgconfig/gstreamer-plugins-base-%{majorminor}.pc
-# .so files
-%{_libdir}/libgstinterfaces-%{majorminor}.so
-@USE_ALSA_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstalsa.so
 
-
+# gtk-doc documentation
-# Here are packages not in the base plugins package but not dependant
+%doc %{_datadir}/gtk-doc/html/gst-plugins-base-libs-%{majorminor}
-# on an external lib
+%doc %{_datadir}/gtk-doc/html/gst-plugins-base-plugins-%{majorminor}
-
-### VIDEO 4 LINUX 2 ###
-# @USE_GST_V4L2_TRUE@%package -n gstreamer-plugins-v4l2
-# @USE_GST_V4L2_TRUE@Summary:       GStreamer Video for Linux 2 plug-in
-# @USE_GST_V4L2_TRUE@Group:         Applications/Multimedia
-# @USE_GST_V4L2_TRUE@Requires:      gstreamer-plugins09 = %{version}
-# @USE_GST_V4L2_TRUE@BuildRequires: glibc-devel
-# @USE_GST_V4L2_TRUE@Obsoletes:	  gstreamer-v4l2
-# @USE_GST_V4L2_TRUE@
-# @USE_GST_V4L2_TRUE@%description -n gstreamer-plugins-v4l2
-# @USE_GST_V4L2_TRUE@Plug-in for accessing Video for Linux devices.
-# @USE_GST_V4L2_TRUE@
-# @USE_GST_V4L2_TRUE@%files -n gstreamer-plugins-v4l2
-# @USE_GST_V4L2_TRUE@%defattr(-, root, root)
-# @USE_GST_V4L2_TRUE@%{_libdir}/gstreamer-%{majorminor}/libgstvideo4linux2.so
-# @USE_GST_V4L2_TRUE@
-# @USE_GST_V4L2_TRUE@%post -n gstreamer-plugins-v4l2
-# @USE_GST_V4L2_TRUE@%{register}
-# @USE_GST_V4L2_TRUE@
-# @USE_GST_V4L2_TRUE@%postun -n gstreamer-plugins-v4l2
-# @USE_GST_V4L2_TRUE@%{register}
 
 %changelog
 * Fri Sep 02 2005 Thomas Vander Stichele <thomas at apestaart dot org>