adding gst-uninstalled script

Original commit message from CVS:
adding gst-uninstalled script

ChangeLog

@@ -1,3 +1,15 @@
+2004-02-16  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+	* docs/faq/Makefile.am:
+          add script to run gstreamer uninstalled 
+	* docs/faq/faq.xml:
+	* docs/faq/developing.xml:
+	* docs/faq/gst-uninstalled:
+          extract script to run gstreamer uninstalled
+	* docs/manuals.mak:
+          add EXTRA_SOURCES variable for Makefile.am's to set to
+          use additional SOURCE files for the doc build
+
 2004-02-16  Thomas Vander Stichele  <thomas at apestaart dot org>
 
 	* gst/gstatomic_impl.h: Fedora 2 test package patch for S390

docs/faq/Makefile.am

@@ -16,6 +16,9 @@ CSS = base.css
 PNG_SRC = 
 FIG_SRC = $(notdir $(wildcard $(srcdir)/*.fig))
 
+# extra sources to copy in build directory
+EXTRA_SOURCES = gst-uninstalled
+
 ### this is the generic bit and you shouln't need to change this
 
 # get the generic docbuilding Makefile stuff

docs/faq/developing.xml

@@ -49,29 +49,7 @@ gstreamer and gst-plugins (for example, against CVS copies).
 The easiest way to do this is to use a script like this (for bash):
 
 <programlisting>
-#!/bin/bash -i
-# set up environment to use and develop gstreamer from uninstalled
-# this is run -i so that PS1 doesn't get cleared
-                                                                                
-# extract version from $0
-# gst-cvs -> cvs
-VERSION=`echo $0 | sed s/.*gst-//g`
-echo $VERSION
-                                                                                
-# base path under which dirs are installed
-GST=~/gst/$VERSION
-if test ! -e $GST; then
-  echo "$GST does not exist !"
-  exit
-fi
-                                                                                
-# set up a bunch of paths
-PATH=$GST/gstreamer/tools:$GST/gst-plugins/tools:$PATH
-export PKG_CONFIG_PATH=$GST/gstreamer/pkgconfig:$GST/gst-plugins/pkgconfig
-export GST_PLUGIN_PATH=$GST/gstreamer:$GST/gst-plugins
-                                                                                
-# set up prompt to help us remember we're in a subshell and start bash
-PS1="[gst-$VERSION] $PS1" bash
+&gst-uninstalled;
 </programlisting>
 If you put this script in your path, and symlink it to gst-cvs (if you want
 to develop against cvs HEAD) or to gst-0.6 (if you want to develop against the

docs/faq/faq.xml

@@ -7,6 +7,8 @@
 <!ENTITY % version-entities SYSTEM "version.entities">
 %version-entities;
 
+<!ENTITY gst-uninstalled SYSTEM "gst-uninstalled">
+
 <!ENTITY START SYSTEM "start.xml">
 <!ENTITY GENERAL SYSTEM "general.xml">
 <!ENTITY DEPENDENCIES SYSTEM "dependencies.xml">

docs/faq/gst-uninstalled

@@ -0,0 +1,55 @@
+#!/bin/bash -i
+# set up environment to use and develop gstreamer and friends uninstalled
+#
+# set up PATH, LD_LIBRARY_PATH, PKG_CONFIG_PATH, GST_PLUGIN_PATH, MANPATH,
+# PYTHONPATH
+#
+# 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
+#
+# symlink this script in a directory in your path (for example $HOME/bin)
+# to a name that reflects the version of your checkout
+#
+# e.g.:
+# - mkdir $HOME/gst/head
+# - ln -sf gst-uninstalled $HOME/bin/gst-head
+# - checkout copies of gstreamer modules in $HOME/gst/head
+# - gst-head
+
+# 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
+MYGST=$HOME/gst
+
+# extract version from $0
+# if this script is called "gst-head" then version will be "head"
+VERSION=`echo $0 | sed s/.*gst-//g`
+
+# base path under which dirs are installed
+GST=$MYGST/$VERSION
+if test ! -e $GST; then
+  echo "$GST does not exist !"
+  exit
+fi
+
+# set up a bunch of paths
+PATH=$GST/gstreamer/tools:$GST/gst-plugins/tools:$GST/gst-player/src:$GST/gst-editor/src:$GST/prefix/bin:$PATH
+export LD_LIBRARY_PATH=$GST/prefix/lib:$LD_LIBRARY_PATH
+export PKG_CONFIG_PATH=$GST/gstreamer/pkgconfig:$GST/gst-plugins/pkgconfig
+export GST_PLUGIN_PATH=$GST/gstreamer:$GST/gst-plugins:$GST/gst-ffmpeg
+export MANPATH=$GST/gstreamer/tools:$GST/prefix/share/man:$MANPATH
+export PYTHONPATH=$GST/gst-python:$PYTHONPATH
+
+# if we got a command, run it, else start a shell
+if test ! -z "$1";
+then
+  $@
+  exit $?
+fi
+
+# set up prompt to help us remember we're in a subshell and start $SHELL
+cd $GST
+PS1="[gst-$VERSION] $PS1" $SHELL

docs/manuals.mak

@@ -28,7 +28,7 @@ EPS_BUILT = $(foreach file, $(EPS), $(BUILDIMAGESDIR)/$(file))
 PDF_BUILT = $(foreach file, $(PDF), $(BUILDIMAGESDIR)/$(file))
 
 # everything considered source
-SRC = $(XML) $(PNG_SRC) $(FIG_SRC) $(CSS)
+SRC = $(XML) $(PNG_SRC) $(FIG_SRC) $(CSS) $(EXTRA_SOURCES)
 
 # generate A4 docs
 PAPER_LOCALE = nl_NL
@@ -84,8 +84,9 @@ debug:
 	@echo "PDF_DAT:  '$(PDF_DAT)'"
 
 # a rule to copy all of the source for docs into $(builddir)/build
-$(BUILDDIR)/$(MAIN): $(XML) $(CSS)
+$(BUILDDIR)/$(MAIN): $(XML) $(CSS) $(EXTRA_SOURCES)
 	@-mkdir -p $(BUILDDIR)
+	@if test "x$(EXTRA_SOURCES)" != "x"; then for a in $(EXTRA_SOURCES); do cp $(srcdir)/$$a $(BUILDDIR); done; fi
 	@for a in $(XML); do cp $(srcdir)/$$a $(BUILDDIR); done
 	@for a in $(CSS); do cp $(srcdir)/$$a $(BUILDDIR); done
 	@cp ../version.entities $(BUILDDIR)