entitize the version
authorThomas Vander Stichele <thomas@apestaart.org>
Wed, 8 Oct 2003 18:21:41 +0000 (18:21 +0000)
committerThomas Vander Stichele <thomas@apestaart.org>
Wed, 8 Oct 2003 18:21:41 +0000 (18:21 +0000)
Original commit message from CVS:
entitize the version

15 files changed:
docs/Makefile.am
docs/faq/developing.xml
docs/faq/faq.xml
docs/gst/tmpl/gstcaps.sgml
docs/gst/tmpl/gstelementfactory.sgml
docs/gst/tmpl/gstevent.sgml
docs/gst/tmpl/gstpad.sgml
docs/gst/tmpl/gstregistry.sgml
docs/gst/tmpl/gsttypefactory.sgml
docs/gst/tmpl/gstxml.sgml
docs/manual/basics-helloworld.xml
docs/manual/helloworld.xml
docs/manual/helloworld2.xml
docs/manual/manual.xml
docs/manuals.mak

index 8c6e4e6..395b7e8 100644 (file)
@@ -14,7 +14,9 @@ endif
 SUBDIRS = $(SUBDIRS_DOCS) $(SUBDIRS_PLUGINS)
 DIST_SUBDIRS = faq manual pwg gst libs plugins xsl
 
-EXTRA_DIST = slides manuals.mak htmlinstall.mak image-png image-pdf image-eps
+EXTRA_DIST = \
+       slides manuals.mak htmlinstall.mak \
+       image-png image-pdf image-eps version.entities.in
 
 dist-hook:
        $(RM) -rf $(distdir)/random/CVS
index a200dcf..d290515 100644 (file)
@@ -20,12 +20,12 @@ If you're not familiar with pkg-config to compile and link a small
 one-file program, pass the --cflags and --libs arguments to pkg-config.
 For example:
 <programlisting>
-$ gcc `pkg-config --cflags --libs gstreamer-0.7` -o myprog myprog.c
+$ gcc `pkg-config --cflags --libs gstreamer-&GST_MAJORMINOR;` -o myprog myprog.c
 </programlisting>
 would be sufficient for a gstreamer-only program. 
 If (for example) your app also used GTK+ 2.0, you could use
 <programlisting>
-$ gcc `pkg-config --cflags --libs gstreamer-0.7 gtk+-2.0` -o myprog myprog.c
+$ gcc `pkg-config --cflags --libs gstreamer-&GST_MAJORMINOR; gtk+-2.0` -o myprog myprog.c
 </programlisting>
 Those are back-ticks (on the same key with the tilde on US keyboards), 
 not single quotes.
@@ -107,13 +107,13 @@ to use the gstgconf library.  It provides functions to parse the GConf key
 to a usable pipeline.
         </para>
         <para>
-To link against gstgconf, use pkg-config to query the gstreamer-libs-0.7.pc file
+To link against gstgconf, use pkg-config to query the gstreamer-libs-&GST_MAJORMINOR;.pc file
 for link flags, and add -lgstgconf to the link flags.
 This fragment of configure.ac shows how to use pkg-config to get the LIBS:
         </para>
 <programlisting>
 dnl check for GStreamer helper libs
-PKG_CHECK_MODULES(GST_HELPLIBS, gstreamer-libs-0.7 >= $GSTREAMER_REQ,,exit)
+PKG_CHECK_MODULES(GST_HELPLIBS, gstreamer-libs-&GST_MAJORMINOR; >= $GSTREAMER_REQ,,exit)
 AC_SUBST(GST_HELPLIBS_LIBS)
 AC_SUBST(GST_HELPLIBS_CFLAGS)
 </programlisting>
index 36dfa5e..23bae58 100644 (file)
@@ -4,6 +4,8 @@
 
 <!ENTITY % image-entities SYSTEM "image.entities">
 %image-entities;
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
 
 <!ENTITY START SYSTEM "start.xml">
 <!ENTITY GENERAL SYSTEM "general.xml">
index 0b7c1e5..65f1399 100644 (file)
@@ -471,25 +471,27 @@ The name used for tracing
 @Returns: 
 
 
-<!-- ##### MACRO gst_caps_has_property ##### -->
+<!-- ##### FUNCTION gst_caps_has_property ##### -->
 <para>
 Check if the GstCaps has a property with the given name
 </para>
 
 @caps: the caps to query
 @name: the name of the property
+@Returns: 
 
 
-<!-- ##### MACRO gst_caps_has_fixed_property ##### -->
+<!-- ##### FUNCTION gst_caps_has_fixed_property ##### -->
 <para>
 Check if the GstCaps has a fixed property with the given name
 </para>
 
 @caps: the caps to query
 @name: the name of the property
+@Returns: 
 
 
-<!-- ##### MACRO gst_caps_has_property_typed ##### -->
+<!-- ##### FUNCTION gst_caps_has_property_typed ##### -->
 <para>
 Check if the GstCaps has a property with the given type
 </para>
@@ -497,6 +499,7 @@ Check if the GstCaps has a property with the given type
 @caps: the caps to query
 @name: the name of the property
 @type: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gst_caps_normalize ##### -->
index 4bca3a0..eddebe8 100644 (file)
@@ -147,7 +147,7 @@ describes the element, mostly for the benefit of editors.
 @Returns: 
 
 
-<!-- ##### FUNCTION gst_element_factory_set_rank ##### -->
+<!-- ##### MACRO gst_element_factory_set_rank ##### -->
 <para>
 
 </para>
index 7e8fe53..a32604f 100644 (file)
@@ -47,6 +47,7 @@ The different major types of events.
 @GST_EVENT_TS_OFFSET: an event to set the time offset on buffers
 @GST_EVENT_INTERRUPT: mainly used by _get based elements when they were interrupted
                       while waiting for a buffer.
+@GST_EVENT_NAVIGATION: 
 
 <!-- ##### MACRO GST_EVENT_TYPE ##### -->
 <para>
index 11acfd6..a557ac6 100644 (file)
@@ -1068,6 +1068,7 @@ The realpad object
 @getcapsfunc: 
 @direction: 
 @linkfunc: 
+@unlinkfunc: 
 @peer: 
 @sched_private: 
 @chainfunc: 
index df4ebe4..4a60058 100644 (file)
@@ -49,7 +49,6 @@ The registry object
 @loaded: 
 @plugins: 
 @paths: 
-@dummy: 
 
 <!-- ##### FUNCTION gst_registry_load ##### -->
 <para>
index 0824192..5b65c24 100644 (file)
@@ -73,10 +73,12 @@ This is the function that will be called when a typefind has to be
 performed by a plugin.
 </para>
 
-@buf: the buffer with media on which to perform the typefind
+@bs: 
 @priv: private; don't touch
 @Returns: A #GstCaps structure describing the type or NULL if the
          type was not recognized by this function;
+<!-- # Unused Parameters # -->
+@buf: the buffer with media on which to perform the typefind
 
 
 <!-- ##### FUNCTION gst_type_factory_new ##### -->
index 32d00bc..08450b2 100644 (file)
@@ -110,6 +110,10 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
 
 </para>
 
+@: 
+@: 
+@:
+
 @gstxml: the object which received the signal.
 @arg1: 
 @arg2: 
@@ -119,7 +123,7 @@ All GstElements can be serialized to an XML presentation and subsequently loaded
 
 </para>
 
-@
-@: 
-@: 
+@gstxml: the object which received the signal.
+@arg1
+@arg2
 
index 011ae90..f949115 100644 (file)
@@ -238,7 +238,7 @@ main (int argc, char *argv[])
       To compile the helloworld example, use: 
     </para>
     <programlisting>
-       gcc -Wall `pkg-config gstreamer-0.7 --cflags --libs` helloworld.c \
+       gcc -Wall `pkg-config gstreamer-&GST_MAJORMINOR; --cflags --libs` helloworld.c \
              -o helloworld 
     </programlisting>
     <para>
index 011ae90..f949115 100644 (file)
@@ -238,7 +238,7 @@ main (int argc, char *argv[])
       To compile the helloworld example, use: 
     </para>
     <programlisting>
-       gcc -Wall `pkg-config gstreamer-0.7 --cflags --libs` helloworld.c \
+       gcc -Wall `pkg-config gstreamer-&GST_MAJORMINOR; --cflags --libs` helloworld.c \
              -o helloworld 
     </programlisting>
     <para>
index bb8db97..5a382c4 100644 (file)
@@ -247,7 +247,7 @@ main (int argc, char *argv[])
       To compile the helloworld2 example, use: 
     </para>
     <programlisting>
-       gcc -Wall `pkg-config gstreamer-0.7 --cflags --libs` helloworld2.c \
+       gcc -Wall `pkg-config gstreamer-&GST_MAJORMINOR; --cflags --libs` helloworld2.c \
              -o helloworld2 
     </programlisting>
     <para>
index 4f12d5a..a5503fa 100644 (file)
@@ -3,6 +3,8 @@
                   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
 <!ENTITY % image-entities SYSTEM "image.entities">
 %image-entities;
+<!ENTITY % version-entities SYSTEM "version.entities">
+%version-entities;
 
 <!ENTITY INTRO SYSTEM "intro.xml">
 <!ENTITY MOTIVATION SYSTEM "motivation.xml">
index 7b5f9c2..21e61f2 100644 (file)
@@ -86,6 +86,7 @@ $(BUILDDIR)/$(MAIN): $(XML) $(CSS)
        @-mkdir -p $(BUILDDIR)
        @for a in $(XML); do cp $(srcdir)/$$a $(BUILDDIR); done
        @for a in $(CSS); do cp $(srcdir)/$$a $(BUILDDIR); done
+       @cp $(srcdir)/../version.entities $(BUILDDIR)
 
 html/index.html: $(BUILDDIR)/$(MAIN) $(PNG_BUILT) $(FIG_SRC)
        @echo "*** Generating HTML output ***"