[LV-tools-commit] toolchain/scripts README,1.10,1.11

[Jan-Benedict G. <jb...@us...>]

Update of /cvsroot/linux-vax/toolchain/scripts
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv30857

Modified Files:
	README 
Log Message:
- Finally update the README, too, to reflect the newly added uClibc
  repo.


Index: README
===================================================================
RCS file: /cvsroot/linux-vax/toolchain/scripts/README,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- README	15 Apr 2005 10:48:17 -0000	1.10
+++ README	5 Jun 2005 16:24:29 -0000	1.11
@@ -8,11 +8,12 @@
 vax_toolchain_config
 ~~~~~~~~~~~~~~~~~~~~
 This script is ment to be sourced by you into your shell. It'll set some
-environment variables (where to find patches, CVS sandboxes, build space, ...)
-Please feel free to add your pathes and check it in. This script will
-always look a bit messy, so don't care about it... Also, the very first
-thing you'd do it to actually source it, because all other scripts depend on
-the variables being set here. To source this file, use this:
+environment variables (where to find patches, CVS/SVN sandboxes, build
+space, ...)  Please feel free to add your pathes and check it in. This
+script will always look a bit messy, so don't care about it... Also, the
+very first thing you'd do it to actually source it, because all other
+scripts depend on the variables being set here. To source this file, use
+this:
 
 $ . /path/to/vax_toolchain_config
 
@@ -25,14 +26,14 @@
 prepare_toolchain_hacking.sh
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This script copies the locally checked-out upstream sandbox for named
-components (binutils, gcc, glibc, ports) and--if requested--applies
-all VAX-specific patches. You'd call this script like:
+components (binutils, gcc, glibc, ports, uclibc) and--if requested--
+applies all VAX-specific patches. You'd call this script like:
 
 $ prepare_toolchain_hacking.sh add_new_documentation gcc+patches
 
 This will create a directory ./add_new_documentation/ containing two
-copies of the upstream CVS sandboxes, src-COMPONENT-fresh/ and
-src-COMPONENT-hacked/ .  Please do all your hacking in the *-hacked/
+copies of the upstream CVS sandboxes, src-$COMPONENT-fresh/ and
+src-$COMPONENT-hacked/ .  Please do all your hacking in the *-hacked/
 directory. You can later on diff out your changes with:
 
 $ diff -Nurp src-COMPONENT-* > add_new_documentation.patch
@@ -62,30 +63,34 @@
 	- Apply patches if you didn't ask for omitting this step
 	- configure & build & check & install binutils
 	- configure & build & check & install first-stage GCC
+	- Maybe it'll try other components (like glibc/uclibc and another
+	  run on gcc for including userspace support).
 
 This script knows quite some command line arguments. Maybe call it once with
 --help...  The last argument is the target to build for, which defaults to
-vax-linux.
+vax-linux. If you don't want to do specific things (like tracking down
+breakages using binary search) you don't need any arguments at all. Just run
+it.
 
 
 initial_cvs_checkout.sh
 ~~~~~~~~~~~~~~~~~~~~~~~
-This script will check out all upstream CVS repos for you and place them
+This script will check out all upstream CVS/SVN repos for you and place them
 into the $UPSTREAM_SANDBOXES_PATH path.
 
 
 update_upstream_cvs_sandboxes.sh
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-This script will update all your checked-out upstream CVS sandboxes to
-their respective HEAD versions. You'd run it everytime before you start
-a build, prepare for hacking or whatever.
+This script will update all your checked-out upstream CVS/SVN sandboxes to
+their respective HEAD versions. You'd run it everytime before you start a
+build, prepare for hacking or whatever.
 
 
 generate_upstream_patches.sh
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 You can use this script to diff out the *-HEAD/ sandboxes with the
 *-HEAD-last/ sandboxes. This will, however, _not_ update the *-HEAD-last/
-sandboxes! The broken out patches will be placed into ${UPSTREAM_PATCHES_PATH}.
+sandboxes! The broken out patches will be placed into $UPSTREAM_PATCHES_PATH.
 
 
 generate_and_apply_upstream_patches.sh
@@ -98,12 +103,12 @@
 
 try_patches.sh
 ~~~~~~~~~~~~~~
-This script gets three arguments (component (like binutils, gcc, glibc, ports),
-the directory containing sources to be patched and a directory containing
-patches). All patches (in the patches directory) are expected to follow this
-filename convention:
+This script gets three arguments (component (like binutils, gcc, glibc, ports
+or uclibc), the directory containing sources to be patched and a directory
+containing patches). All patches (in the patches directory) are expected to
+follow this filename convention:
 
-	${3}/COMPONENT-nnnnnn-some_description.patch
+	${3}/$COMPONENT-nnnnnn-some_description.patch
 
 
 copy_directory.sh