docs/faq/gst-uninstalled: Clarify the comments to make the usage of this script and...

Original commit message from CVS:
* docs/faq/gst-uninstalled:
Clarify the comments to make the usage of this script and what it
does easier to understand.

diff --git a/ChangeLog b/ChangeLog
index 0e5d789fb9bb791cf3e7f6d04d0d881ed368a44d..a9ffc5fa37030c84fb5b5f735e7f601c5630f406 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-01-03  Sebastian Dröge  <slomo@circular-chaos.org>
+
+       * docs/faq/gst-uninstalled:
+       Clarify the comments to make the usage of this script and what it
+       does easier to understand.
+
 2008-01-01  Thijs Vermeir  <thijsvermeir@gmail.com>
 
        * tools/gst-plot-timeline.py:

diff --git a/docs/faq/gst-uninstalled b/docs/faq/gst-uninstalled
index 2ff1e9d24dbf8a4746e01ce5dda52ddc08b2473f..7c0adb85776c09f20b7fc3f9ecb9b06b1ed38bd2 100755 (executable)
--- a/docs/faq/gst-uninstalled
+++ b/docs/faq/gst-uninstalled
@@ -2,18 +2,22 @@
 #
 # this script is in CVS as gstreamer/docs/faq/gst-uninstalled
 #
-# set up environment to use and develop gstreamer and friends uninstalled
+# It will set up the environment to use and develop gstreamer and projects
+# that use gstreamer with an uninstalled CVS checkout of gstreamer and the
+# plugin modules.
 #
-# set up PATH, LD_LIBRARY_PATH, PKG_CONFIG_PATH, GST_PLUGIN_PATH, MANPATH,
-# PYTHONPATH
+# It will set up LD_LIBRARY_PATH, DYLD_LIBRARY_PATH, PKG_CONFIG_PATH,
+# GST_PLUGIN_PATH, GST_PLUGIN_SYSTEM_PATH, GST_REGISTRY, MANPATH, PYTHONPATH
+# to prefer the uninstalled versions but also contain the installed ones.
+# The only exception to this is, that no system installed plugins will be
+# used but only the uninstalled ones.
 #
-# prefer uninstalled versions, but also put installed ones on the path
+# This script assumes that the relevant modules are checked out one by one
+# under a given tree specified below in MYGST.
 #
-# this script assumes that the relevant modules are checked out one by one
-# under a given tree specified below in MYGST
-#
-# symlink this script in a directory in your path (for example $HOME/bin)
-# to a name that reflects the version of your checkout
+# Symlink this script in a directory in your path (for example $HOME/bin). You
+# must name the symlink gst-something, where something is the subdirectory
+# of MYGST that contains your gstreamer module checkouts.
 #
 # e.g.:
 # - mkdir $HOME/gst/head
@@ -21,12 +25,15 @@
 # - checkout copies of gstreamer modules in $HOME/gst/head
 # - gst-head
 
-# this script is run -i so that PS1 doesn't get cleared
+# This script is run -i so that PS1 doesn't get cleared
 
-# change this variable to a different location depending on where you
-# store your cvs checkouts
+# Change this variable to the location of your gstreamer CVS checkouts
 MYGST=$HOME/gst
 
+#
+# Everything below this line shouldn't be edited!
+#
+
 # extract version from $0
 # if this script is called "gst-head" then version will be "head"
 VERSION=`echo $0 | sed s/.*gst-//g`