summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOlivier CrĂȘte <olivier.crete@collabora.com>2011-10-11 14:55:29 -0400
committerOlivier CrĂȘte <olivier.crete@collabora.com>2011-10-11 16:14:07 -0400
commite33572c56e93ad1a0f644047f30fc23ab5e01372 (patch)
tree2347860066da7fa0c91df89dc86a06e4e012236c /docs
parent449a53f65146448d70f761cc1257171702c83db4 (diff)
downloadfarstream-e33572c56e93ad1a0f644047f30fc23ab5e01372.tar.gz
Rename Farsight 2 to Farstream
Diffstat (limited to 'docs')
-rw-r--r--docs/codingstyle.txt14
-rw-r--r--docs/diagrams/farsight2-references.svg4
-rw-r--r--docs/libs/Makefile.am8
-rw-r--r--docs/libs/farsight2-libs-docs.sgml18
-rw-r--r--docs/libs/farsight2-libs-sections.txt24
-rw-r--r--docs/libs/farsight2-libs.types14
-rw-r--r--docs/multi-party-negotiation.txt2
-rw-r--r--docs/plugins/Makefile.am12
-rw-r--r--docs/plugins/farsight2-plugins-docs.sgml8
-rw-r--r--docs/plugins/farsight2-transmitters.types.in2
-rw-r--r--docs/version.entities.in2
11 files changed, 54 insertions, 54 deletions
diff --git a/docs/codingstyle.txt b/docs/codingstyle.txt
index 5f26f82e..b6711995 100644
--- a/docs/codingstyle.txt
+++ b/docs/codingstyle.txt
@@ -1,7 +1,7 @@
-This page describes the Farsight2 coding style. Respect it or die.
+This page describes the Farstream coding style. Respect it or die.
It is a copy of
-http://farsight.freedesktop.org/wiki/Fs2CodingStyle
+http://farstream.freedesktop.org/wiki/Fs2CodingStyle
They should both be in sync
@@ -27,7 +27,7 @@ Base indent unit is 2 spaces.
The first parameter is on the same line as the function only if the function is a method.
-static void farsight_rtp_stream_get_property (GObject *object,
+static void farstream_rtp_stream_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec);
@@ -37,7 +37,7 @@ static void farsight_rtp_stream_get_property (GObject *object,
The first parameter is on the same line as the function only if the function is a method.
static void
-farsight_rtp_stream_get_property (GObject * object,
+farstream_rtp_stream_get_property (GObject * object,
guint prop_id,
GValue * value,
GParamSpec * pspec)
@@ -90,7 +90,7 @@ switch (var)
==== Casting ====
-FarsightRTPStream *self = (FarsightRTPStream *) stream;
+FarstreamRTPStream *self = (FarstreamRTPStream *) stream;
==== #includes ====
@@ -106,8 +106,8 @@ Finally, #include any private (non-installed) headers from the library or progra
==== Emacs mode ====
-(defun farsight2-c-mode ()
- "C mode with farsight2 style"
+(defun farstream-c-mode ()
+ "C mode with farstream style"
(interactive)
(c-mode)
(c-set-style "GNU")
diff --git a/docs/diagrams/farsight2-references.svg b/docs/diagrams/farsight2-references.svg
index ce598689..b31675e1 100644
--- a/docs/diagrams/farsight2-references.svg
+++ b/docs/diagrams/farsight2-references.svg
@@ -15,9 +15,9 @@
sodipodi:version="0.32"
inkscape:version="0.46"
sodipodi:docbase="/home/tester"
- sodipodi:docname="farsight2-references.svg"
+ sodipodi:docname="farstream-references.svg"
inkscape:output_extension="org.inkscape.output.svg.inkscape"
- inkscape:export-filename="/home/tester/farsight2-references.png"
+ inkscape:export-filename="/home/tester/farstream-references.png"
inkscape:export-xdpi="90"
inkscape:export-ydpi="90">
<defs
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 9e2ffb46..866b81f6 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -5,7 +5,7 @@
# The name of the module, e.g. 'glib'.
#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
-DOC_MODULE=farsight2-libs
+DOC_MODULE=farstream-libs
# generated basefiles
basefiles = \
@@ -46,7 +46,7 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
# this is useful ;)
SCANOBJ_DEPS = \
- $(top_builddir)/gst-libs/gst/farsight/libgstfarsight-@GST_MAJORMINOR@.la
+ $(top_builddir)/gst-libs/gst/farstream/libgstfarstream-@GST_MAJORMINOR@.la
# Header files to ignore when scanning.
IGNORE_HFILES = fs-marshal.h fs-enumtypes.h fs-private.h
@@ -62,9 +62,9 @@ extra_files =
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
# contains GtkObjects/GObjects and you want to document signals and properties.
-GTKDOC_CFLAGS = $(FS2_INTERNAL_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
+GTKDOC_CFLAGS = $(FS_INTERNAL_CFLAGS) $(GST_PLUGINS_BASE_CFLAGS) $(GST_BASE_CFLAGS)
GTKDOC_LIBS = -static \
- $(top_builddir)/gst-libs/gst/farsight/libgstfarsight-0.10.la \
+ $(top_builddir)/gst-libs/gst/farstream/libgstfarstream-0.10.la \
$(GST_BASE_LIBS) \
$(GCOV_LIBS)
diff --git a/docs/libs/farsight2-libs-docs.sgml b/docs/libs/farsight2-libs-docs.sgml
index fe7d119a..305d039a 100644
--- a/docs/libs/farsight2-libs-docs.sgml
+++ b/docs/libs/farsight2-libs-docs.sgml
@@ -6,20 +6,20 @@
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
- <title>Farsight2 Reference Manual</title>
+ <title>Farstream Reference Manual</title>
<releaseinfo>
- for version &FS2_VERSION;.
+ for version &FS_VERSION;.
The latest version of this documentation can be found on-line at
- <ulink role="online-location" url="http://farsight.freedesktop.org/apidoc/farsight2/">http://farsight.freedesktop.org/apidoc/farsight2/</ulink>.
+ <ulink role="online-location" url="http://farstream.freedesktop.org/apidoc/farstream/">http://farstream.freedesktop.org/apidoc/farstream/</ulink>.
The bases classes are implemented by multiple plugins described in
- the <ulink url="http://farsight.freedesktop.org/apidoc/farsight2-plugins/">Farsight2 Plugins Manual</ulink>.
+ the <ulink url="http://farstream.freedesktop.org/apidoc/farstream-plugins/">Farstream Plugins Manual</ulink>.
</releaseinfo>
</bookinfo>
<part>
<title>User-oriented classes, interfaces and functions</title>
<chapter>
- <title>Farsight Core Library</title>
+ <title>Farstream Core Library</title>
<xi:include href="xml/fs-conference.xml"/>
<xi:include href="xml/fs-participant.xml"/>
<xi:include href="xml/fs-session.xml"/>
@@ -32,20 +32,20 @@
<xi:include href="xml/fs-rtp.xml"/>
</chapter>
<chapter>
- <title>Farsight Utility Functions and Objects</title>
+ <title>Farstream Utility Functions and Objects</title>
<xi:include href="xml/fs-element-added-notifier.xml"/>
<xi:include href="xml/fs-utils.xml"/>
</chapter>
</part>
<part>
- <title>Classes used to implement Farsight plugins</title>
+ <title>Classes used to implement Farstream plugins</title>
<chapter>
- <title>Farsight Transmitter Classes</title>
+ <title>Farstream Transmitter Classes</title>
<xi:include href="xml/fs-transmitter.xml"/>
<xi:include href="xml/fs-stream-transmitter.xml"/>
</chapter>
<chapter>
- <title>Farsight Plugins Infrastructure</title>
+ <title>Farstream Plugins Infrastructure</title>
<xi:include href="xml/fs-plugin.xml"/>
</chapter>
</part>
diff --git a/docs/libs/farsight2-libs-sections.txt b/docs/libs/farsight2-libs-sections.txt
index 2362eb22..4a220fb1 100644
--- a/docs/libs/farsight2-libs-sections.txt
+++ b/docs/libs/farsight2-libs-sections.txt
@@ -1,7 +1,7 @@
<SECTION>
<FILE>fs-participant</FILE>
<TITLE>FsParticipant</TITLE>
-<INCLUDE>gst/farsight/fs-conference.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-conference.h</INCLUDE>
FsParticipant
FsParticipantClass
FS_PARTICIPANT_DATA_LOCK
@@ -21,7 +21,7 @@ FsParticipantPrivate
<SECTION>
<FILE>fs-stream</FILE>
<TITLE>FsStream</TITLE>
-<INCLUDE>gst/farsight/fs-conference.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-conference.h</INCLUDE>
FsStream
FsStreamClass
FsStreamDirection
@@ -52,7 +52,7 @@ FsStreamPrivate
FsDTMFEvent
FsDTMFMethod
<TITLE>FsSession</TITLE>
-<INCLUDE>gst/farsight/fs-conference.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-conference.h</INCLUDE>
FsSession
FsSessionClass
fs_session_new_stream
@@ -84,7 +84,7 @@ FS_IS_CONFERENCE_CLASS
<SECTION>
<FILE>fs-conference</FILE>
<TITLE>FsConference</TITLE>
-<INCLUDE>gst/farsight/fs-conference.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-conference.h</INCLUDE>
FsConference
fs_conference_new_session
fs_conference_new_participant
@@ -104,7 +104,7 @@ fs_error_quark
<SECTION>
<FILE>fs-candidate</FILE>
<TITLE>FsCandidate</TITLE>
-<INCLUDE>gst/farsight/fs-conference.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-conference.h</INCLUDE>
FsCandidate
FsCandidateType
FsNetworkProtocol
@@ -124,7 +124,7 @@ fs_candidate_list_get_type
<SECTION>
<FILE>fs-codec</FILE>
<TITLE>FsCodec</TITLE>
-<INCLUDE>gst/farsight/fs-conference.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-conference.h</INCLUDE>
FsCodec
FsMediaType
FsCodecParameter
@@ -159,7 +159,7 @@ fs_codec_list_get_type
<SECTION>
<FILE>fs-transmitter</FILE>
<TITLE>FsTransmitter</TITLE>
-<INCLUDE>gst/farsight/fs-transmitter.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-transmitter.h</INCLUDE>
FsTransmitter
FsTransmitterClass
fs_transmitter_new
@@ -183,7 +183,7 @@ fs_transmitter_get_type
<SECTION>
<FILE>fs-stream-transmitter</FILE>
<TITLE>FsStreamTransmitter</TITLE>
-<INCLUDE>gst/farsight/fs-transmitter.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-transmitter.h</INCLUDE>
FsStreamTransmitter
FsStreamTransmitterClass
fs_stream_transmitter_add_remote_candidates
@@ -206,7 +206,7 @@ fs_stream_transmitter_get_type
<SECTION>
<FILE>fs-plugin</FILE>
<TITLE>FsPlugin</TITLE>
-<INCLUDE>gst/farsight/fs-plugin.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-plugin.h</INCLUDE>
FsPlugin
fs_plugin_create_valist
fs_plugin_create
@@ -227,7 +227,7 @@ fs_plugin_get_type
<SECTION>
<FILE>fs-element-added-notifier</FILE>
<TITLE>FsElementAddedNotifier</TITLE>
-<INCLUDE>gst/farsight/fs-element-added-notifier.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-element-added-notifier.h</INCLUDE>
FsElementAddedNotifier
fs_element_added_notifier_new
fs_element_added_notifier_add
@@ -249,7 +249,7 @@ fs_element_added_notifier_get_type
<SECTION>
<FILE>fs-rtp</FILE>
<TITLE>RTP Specific types</TITLE>
-<INCLUDE>gst/farsight/fs-rtp.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-rtp.h</INCLUDE>
FsRtpHeaderExtension
fs_rtp_header_extension_new
fs_rtp_header_extension_copy
@@ -270,7 +270,7 @@ fs_rtp_header_extension_list_get_type
<SECTION>
<FILE>fs-utils</FILE>
<TITLE>Utility functions</TITLE>
-<INCLUDE>gst/farsight/fs-utils.h</INCLUDE>
+<INCLUDE>gst/farstream/fs-utils.h</INCLUDE>
fs_utils_set_bitrate
fs_utils_get_default_codec_preferences
fs_utils_get_default_element_properties
diff --git a/docs/libs/farsight2-libs.types b/docs/libs/farsight2-libs.types
index cd867146..3c50eeea 100644
--- a/docs/libs/farsight2-libs.types
+++ b/docs/libs/farsight2-libs.types
@@ -6,13 +6,13 @@
% - change output file name from gstreamer-(whatever).html to (whatever).html
% - document properties and signals
-#include "../../gst-libs/gst/farsight/fs-participant.h"
-#include "../../gst-libs/gst/farsight/fs-session.h"
-#include "../../gst-libs/gst/farsight/fs-stream.h"
-#include "../../gst-libs/gst/farsight/fs-conference.h"
-#include "../../gst-libs/gst/farsight/fs-transmitter.h"
-#include "../../gst-libs/gst/farsight/fs-stream-transmitter.h"
-#include "../../gst-libs/gst/farsight/fs-element-added-notifier.h"
+#include "../../gst-libs/gst/farstream/fs-participant.h"
+#include "../../gst-libs/gst/farstream/fs-session.h"
+#include "../../gst-libs/gst/farstream/fs-stream.h"
+#include "../../gst-libs/gst/farstream/fs-conference.h"
+#include "../../gst-libs/gst/farstream/fs-transmitter.h"
+#include "../../gst-libs/gst/farstream/fs-stream-transmitter.h"
+#include "../../gst-libs/gst/farstream/fs-element-added-notifier.h"
fs_participant_get_type
fs_session_get_type
diff --git a/docs/multi-party-negotiation.txt b/docs/multi-party-negotiation.txt
index fc69ea0d..c970babd 100644
--- a/docs/multi-party-negotiation.txt
+++ b/docs/multi-party-negotiation.txt
@@ -11,7 +11,7 @@ RTP multi-party conferencing requires that all parties use the same list of code
- Negotiated the common list in a decentralized manner
-Farsight 2 supports the first two techniques, but not the third (which
+Farstream supports the first two techniques, but not the third (which
is a lot more complicated and error-prone).
To use technique one, one just needs to call
diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 9f81f9a5..8ba1c7fc 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -4,7 +4,7 @@ GST_DOC_SCANOBJ = $(top_srcdir)/common/gstdoc-scangobj
# The name of the module, e.g. 'glib'.
#DOC_MODULE=gst-plugins-libs-@GST_MAJORMINOR@
-MODULE=farsight2
+MODULE=farstream
DOC_MODULE=$(MODULE)-plugins
# generated basefiles
@@ -111,22 +111,22 @@ content_files =
# Other files to distribute.
extra_files = \
- farsight2-transmitters.types.in \
+ farstream-transmitters.types.in \
gtkdoc-scangobj-transmitters
-farsight2-transmitters.types: farsight2-transmitters.types.in Makefile
+farstream-transmitters.types: farstream-transmitters.types.in Makefile
cat $< > $@
- for i in "$(FS2_TRANSMITTER_PLUGINS_SELECTED)"; do \
+ for i in "$(FS_TRANSMITTER_PLUGINS_SELECTED)"; do \
echo "${i}" >> $@ ;\
done
-CLEANFILES = farsight2-transmitters.types
+CLEANFILES = farstream-transmitters.types
# CFLAGS and LDFLAGS for compiling scan program. Only needed if your app/lib
# contains GtkObjects/GObjects and you want to document signals and properties.
GTKDOC_CFLAGS = $(GST_BASE_CFLAGS) -I$(top_builddir) -I$(top_builddir)/gst-libs
GTKDOC_LIBS = \
- $(top_builddir)/gst-libs/gst/farsight/libgstfarsight-0.10.la \
+ $(top_builddir)/gst-libs/gst/farstream/libgstfarstream-0.10.la \
$(top_builddir)/gst/fsrtpconference/libfsrtpconference_doc.la \
$(top_builddir)/gst/fsrawconference/libfsrawconference_doc.la \
$(top_builddir)/gst/fsmsnconference/libfsmsnconference_doc.la \
diff --git a/docs/plugins/farsight2-plugins-docs.sgml b/docs/plugins/farsight2-plugins-docs.sgml
index ab53be16..9495f3a0 100644
--- a/docs/plugins/farsight2-plugins-docs.sgml
+++ b/docs/plugins/farsight2-plugins-docs.sgml
@@ -6,14 +6,14 @@
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
- <title>Farsight2 Plugins Manual</title>
+ <title>Farstream Plugins Manual</title>
<releaseinfo>
- for version &FS2_VERSION;.
+ for version &FS_VERSION;.
The latest version of this documentation can be found on-line at
- <ulink role="online-location" url="http://farsight.freedesktop.org/apidoc/farsight2-plugins/">http://farsight.freedesktop.org/apidoc/farsight2-plugins/</ulink>.
+ <ulink role="online-location" url="http://farstream.freedesktop.org/apidoc/farstream-plugins/">http://farstream.freedesktop.org/apidoc/farstream-plugins/</ulink>.
These plugins are to be used with the base classes and other utility
objects and functions described in the
- <ulink url="http://farsight.freedesktop.org/apidoc/farsight2/">Farsight2 Reference Manual</ulink>.
+ <ulink url="http://farstream.freedesktop.org/apidoc/farstream/">Farstream Reference Manual</ulink>.
</releaseinfo>
</bookinfo>
diff --git a/docs/plugins/farsight2-transmitters.types.in b/docs/plugins/farsight2-transmitters.types.in
index 7f744470..5d8e5bdb 100644
--- a/docs/plugins/farsight2-transmitters.types.in
+++ b/docs/plugins/farsight2-transmitters.types.in
@@ -1 +1 @@
-#include <gst/farsight/fs-transmitter.h>
+#include <gst/farstream/fs-transmitter.h>
diff --git a/docs/version.entities.in b/docs/version.entities.in
index 6494998e..662fc76e 100644
--- a/docs/version.entities.in
+++ b/docs/version.entities.in
@@ -1,2 +1,2 @@
<!ENTITY GST_MAJORMINOR "@GST_MAJORMINOR@">
-<!ENTITY FS2_VERSION "@VERSION@">
+<!ENTITY FS_VERSION "@VERSION@">