summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSebastian Dröge <sebastian.droege@collabora.co.uk>2012-04-04 13:13:52 +0200
committerSebastian Dröge <sebastian.droege@collabora.co.uk>2012-04-04 14:28:55 +0200
commitb0d89da6b66021bc8677b9785998b12b6a00676a (patch)
tree5e4ce2dffca4125e05d96bf47b1fb17b61cd1217 /docs
parent6a0e594ebcadbe8d9e32819579072920ef422274 (diff)
gst: Change versioning
Remove GST_MAJORMINOR and replace it by GST_API_VERSION Also set GST_VERSION_{MAJOR,MINOR,MICRO,NANO} explicitely now. All versions are at 1.0.0 now for the release soon but API/ABI can still change until the 1.0.0 release. Next release versions until 1.0.0 will be 0.10.9X and these will be release candidates. GST_VERSION_* will nonetheless stay at 1.0.0.0.
Diffstat (limited to 'docs')
-rw-r--r--docs/faq/developing.xml4
-rw-r--r--docs/gst/Makefile.am2
-rw-r--r--docs/gst/gstreamer-docs.sgml6
-rw-r--r--docs/gst/running.xml2
-rw-r--r--docs/libs/Makefile.am8
-rw-r--r--docs/libs/gstreamer-libs-docs.sgml12
-rw-r--r--docs/manual/basics-helloworld.xml4
-rw-r--r--docs/plugins/Makefile.am2
-rw-r--r--docs/plugins/gstreamer-plugins-docs.sgml4
-rw-r--r--docs/random/autotools8
-rw-r--r--docs/version.entities.in2
11 files changed, 27 insertions, 27 deletions
diff --git a/docs/faq/developing.xml b/docs/faq/developing.xml
index dafbc4cda..b1459891e 100644
--- a/docs/faq/developing.xml
+++ b/docs/faq/developing.xml
@@ -19,12 +19,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>
-$ libtool --mode=link gcc `pkg-config --cflags --libs gstreamer-&GST_MAJORMINOR;` -o myprog myprog.c
+$ libtool --mode=link gcc `pkg-config --cflags --libs gstreamer-&GST_API_VERSION;` -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>
-$ libtool --mode=link gcc `pkg-config --cflags --libs gstreamer-&GST_MAJORMINOR; gtk+-2.0` -o myprog myprog.c
+$ libtool --mode=link gcc `pkg-config --cflags --libs gstreamer-&GST_API_VERSION; 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.
diff --git a/docs/gst/Makefile.am b/docs/gst/Makefile.am
index cb93e888e..23eac9f48 100644
--- a/docs/gst/Makefile.am
+++ b/docs/gst/Makefile.am
@@ -1,7 +1,7 @@
## Process this file with automake to produce Makefile.in
# The name of the module, e.g. 'glib'.
-# DOC_MODULE=gstreamer-@GST_MAJORMINOR@
+# DOC_MODULE=gstreamer-@GST_API_VERSION@
DOC_MODULE=gstreamer
# don't want $(DOC_MODULE)-scan.c to be built with -Werror
diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index 46de797ef..10045098f 100644
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -8,9 +8,9 @@
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
- <title>GStreamer &GST_MAJORMINOR; Core Reference Manual</title>
+ <title>GStreamer &GST_API_VERSION; Core Reference Manual</title>
<releaseinfo>
- for GStreamer Core &GST_MAJORMINOR; (&GST_VERSION;)
+ for GStreamer Core &GST_API_VERSION; (&GST_VERSION;)
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/</ulink>.
</releaseinfo>
@@ -50,7 +50,7 @@ Windows. It is released under the GNU Library General Public License
<title>GStreamer Core Library</title>
<para>
- libgstreamer-&GST_MAJORMINOR;.so provides all the core GStreamer services,
+ libgstreamer-&GST_API_VERSION;.so provides all the core GStreamer services,
including initialization, plugin management and types,
as well as the object hierarchy that defines elements and bins,
along with some more specialized elements.
diff --git a/docs/gst/running.xml b/docs/gst/running.xml
index 3800437ec..c84b0f620 100644
--- a/docs/gst/running.xml
+++ b/docs/gst/running.xml
@@ -43,7 +43,7 @@ with
<para>
plug-ins in the user's home directory. These are stored in a directory called
<filename>plugins</filename> inside the
-<filename>.gstreamer-&GST_MAJORMINOR;</filename> directory in the user's
+<filename>.gstreamer-&GST_API_VERSION;</filename> directory in the user's
home directory.
</para>
</listitem>
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 932eb31d5..60d7318a4 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -1,7 +1,7 @@
## Process this file with automake to produce Makefile.in
# The name of the module, e.g. 'glib'.
-#DOC_MODULE=gstreamer-libs-@GST_MAJORMINOR@
+#DOC_MODULE=gstreamer-libs-@GST_API_VERSION@
DOC_MODULE=gstreamer-libs
# don't want $(DOC_MODULE)-scan.c to be built with -Werror
@@ -59,9 +59,9 @@ extra_files =
# contains GtkObjects/GObjects and you want to document signals and properties.
GTKDOC_CFLAGS = -I$(top_builddir) -I$(top_builddir)/libs $(GST_OBJ_CFLAGS)
GTKDOC_LIBS = \
- $(top_builddir)/libs/gst/controller/libgstcontroller-@GST_MAJORMINOR@.la \
- $(top_builddir)/libs/gst/base/libgstbase-@GST_MAJORMINOR@.la \
- $(top_builddir)/libs/gst/net/libgstnet-@GST_MAJORMINOR@.la \
+ $(top_builddir)/libs/gst/controller/libgstcontroller-@GST_API_VERSION@.la \
+ $(top_builddir)/libs/gst/base/libgstbase-@GST_API_VERSION@.la \
+ $(top_builddir)/libs/gst/net/libgstnet-@GST_API_VERSION@.la \
$(GST_OBJ_LIBS)
GTKDOC_CC=$(LIBTOOL) --tag=CC --mode=compile $(CC)
diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index 502bd82a2..1d98145f5 100644
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -8,9 +8,9 @@
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
- <title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
+ <title>GStreamer &GST_API_VERSION; Library Reference Manual</title>
<releaseinfo>
- for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)
+ for GStreamer Library &GST_API_VERSION; (&GST_VERSION;)
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/</ulink>.
</releaseinfo>
@@ -29,7 +29,7 @@
<chapter id="gstreamer-base">
<title>GStreamer Base and Utillity Classes</title>
<para>
- libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
+ libgstbase-&GST_API_VERSION;.so provides some base classes to be extended
by elements and utillity classes that are most useful for plugin developers.
</para>
@@ -50,7 +50,7 @@
<chapter id="gstreamer-control">
<title>GStreamer Dynamic Parameter Control</title>
<para>
- libgstcontroller-&GST_MAJORMINOR;.so provides functionality to animate
+ libgstcontroller-&GST_API_VERSION;.so provides functionality to animate
element properties over time.
</para>
@@ -63,7 +63,7 @@
<chapter id="gstreamer-net">
<title>GStreamer Network Classes</title>
<para>
- libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
+ libgstnet-&GST_API_VERSION;.so provides network elements and objects.
</para>
<xi:include href="xml/gstnetclientclock.xml" />
@@ -74,7 +74,7 @@
<chapter id="gstreamer-check">
<title>GStreamer Check Unit Testing</title>
<para>
- libgstcheck-&GST_MAJORMINOR;.so provides functionality for writing
+ libgstcheck-&GST_API_VERSION;.so provides functionality for writing
unit tests that use the check framework.
</para>
diff --git a/docs/manual/basics-helloworld.xml b/docs/manual/basics-helloworld.xml
index 55399fbb6..46360ddaf 100644
--- a/docs/manual/basics-helloworld.xml
+++ b/docs/manual/basics-helloworld.xml
@@ -223,7 +223,7 @@ main (int argc,
<para>
To compile the helloworld example, use: <command>gcc -Wall
helloworld.c -o helloworld
- $(pkg-config --cflags --libs gstreamer-&GST_MAJORMINOR;)</command>.
+ $(pkg-config --cflags --libs gstreamer-&GST_API_VERSION;)</command>.
&GStreamer; makes use of <command>pkg-config</command> to get compiler
and linker flags needed to compile this application.
</para>
@@ -238,7 +238,7 @@ main (int argc,
setup (ie. gst-uninstalled), you will need to use libtool to build the
hello world program, like this: <command>libtool --mode=link gcc -Wall
helloworld.c -o helloworld
- $(pkg-config --cflags --libs gstreamer-&GST_MAJORMINOR;)</command>.
+ $(pkg-config --cflags --libs gstreamer-&GST_API_VERSION;)</command>.
</para>
<para>
You can run this example application with <command>./helloworld
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index cd6ea6383..6bb5083dd 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -3,7 +3,7 @@ GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
## Process this file with automake to produce Makefile.in
# The name of the module, e.g. 'glib'.
-#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
+#DOC_MODULE=gst-plugins-libs-@GST_API_VERSION@
MODULE=gstreamer
DOC_MODULE=$(MODULE)-plugins
diff --git a/docs/plugins/gstreamer-plugins-docs.sgml b/docs/plugins/gstreamer-plugins-docs.sgml
index a6c34e9e0..3787b42ab 100644
--- a/docs/plugins/gstreamer-plugins-docs.sgml
+++ b/docs/plugins/gstreamer-plugins-docs.sgml
@@ -7,9 +7,9 @@
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
- <title>GStreamer Core Plugins &GST_MAJORMINOR; Plugins Reference Manual</title>
+ <title>GStreamer Core Plugins &GST_API_VERSION; Plugins Reference Manual</title>
<releaseinfo>
- for GStreamer Core Plugins &GST_MAJORMINOR; (&GST_VERSION;)
+ for GStreamer Core Plugins &GST_API_VERSION; (&GST_VERSION;)
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/</ulink>.
</releaseinfo>
diff --git a/docs/random/autotools b/docs/random/autotools
index 6cbf1a388..585c49d08 100644
--- a/docs/random/autotools
+++ b/docs/random/autotools
@@ -16,12 +16,12 @@ plugin Makefile.am:
- DO NOT put any libraries in _LDFLAGS. Typically, _LDFLAGS should only
have $(GST_PLUGIN_LDFLAGS)
- when using gst-plugins-base libraries, use $(GST_PLUGINS_BASE_LIBS) then
- add -lgst(library)-$(GST_MAJORMINOR). Example:
+ add -lgst(library)-$(GST_API_VERSION). Example:
libgstsdlvideosink_la_LIBADD = $(GST_PLUGINS_BASE_LIBS) \
- -lgstvideo-$(GST_MAJORMINOR) \
- -lgstaudio-$(GST_MAJORMINOR) \
- -lgstinterfaces-$(GST_MAJORMINOR) \
+ -lgstvideo-$(GST_API_VERSION) \
+ -lgstaudio-$(GST_API_VERSION) \
+ -lgstinterfaces-$(GST_API_VERSION) \
$(SDL_LIBS)
diff --git a/docs/version.entities.in b/docs/version.entities.in
index 7ed71e43c..be8ed4bb3 100644
--- a/docs/version.entities.in
+++ b/docs/version.entities.in
@@ -1,3 +1,3 @@
-<!ENTITY GST_MAJORMINOR "@GST_MAJORMINOR@">
+<!ENTITY GST_API_VERSION "@GST_API_VERSION@">
<!ENTITY GST_VERSION "@PACKAGE_VERSION@">
<!ENTITY GST_PLUGINS_DIR "@PLUGINDIR@">