svn commit: r1335163 - /subversion/trunk/tools/dev/unix-build/README

[st...@apache.org]

Author: stsp
Date: Mon May  7 18:08:20 2012
New Revision: 1335163

URL: http://svn.apache.org/viewvc?rev=1335163&view=rev
Log:
* tools/dev/unix-build/README: More edits to clarify common use cases.

Modified:
    subversion/trunk/tools/dev/unix-build/README

Modified: subversion/trunk/tools/dev/unix-build/README
URL: http://svn.apache.org/viewvc/subversion/trunk/tools/dev/unix-build/README?rev=1335163&r1=1335162&r2=1335163&view=diff
==============================================================================
--- subversion/trunk/tools/dev/unix-build/README (original)
+++ subversion/trunk/tools/dev/unix-build/README Mon May  7 18:08:20 2012
@@ -25,8 +25,7 @@ Usage
 First, choose a directory $(SVN_DEV) to set up the environment.
 For example, $(SVN_DEV) could be the directory "~/svn".
 Note that this directory cannot be changed later because the script
-hardcodes build and link paths relative to the current working
-directory.
+hardcodes build and link paths relative to the current working directory.
 
   $ mkdir $(SVN_DEV)
 
@@ -52,19 +51,37 @@ than one working copy of the same branch
 When the script has finished fetching and building, it uses
 $(SVN_DEV)/prefix to install Subversion libraries and
 binaries. $(SVN_DEV)/prefix/svn-trunk (or whatever you choose to
-build) will contain the latest Subversion binaries: you should add
-$(SVN_DEV)/prefix/svn-trunk/bin to your $PATH to use them. The
-Makefile in $(SVN_DEV)/svn-trunk is configured to build with sane
+build) will contain the latest Subversion binaries. You can add
+$(SVN_DEV)/prefix/svn-trunk/bin to your $PATH to use them:
+
+  $ export PATH="$(SVN_DEV)/prefix/svn-trunk/bin:$PATH"
+
+The Makefile in $(SVN_DEV)/svn-trunk is configured to build with sane
 options: while developing Subversion, simply `svn up` to pull the
 latest changes, `make` and `make install` to install the binaries in
-$(SVN_DEV)/prefix/svn-trunk.
+$(SVN_DEV)/prefix/svn-trunk. This usually works fine. If not, you may
+need to use the 'svn-reset' target and recompile everything.
+
+If at any point, you want to recompile any of the packages with the
+default configuration in Makefile.svn, use the *-clean and *-reset
+target in Makefile.svn before trying to rebuild again. For example:
+
+  $ make svn-clean
+  $ make svn-reset
+  $ make
+
+Or, if you want to recompile svn and all dependencies:
+
+  $ make clean
+  $ make reset
+  $ make
+
+If you want to remove everything including the installed binaries effectively
+returning to the starting point, use the "nuke" target (BE CAREFUL, this will
+remove the 'svn' binary compiled from trunk which you might need to manage
+existing working copies):
 
-If at any point, you want to re-configure any of the packages to the
-default configuration in Makefile.svn, just run the "<PACKAGE>-reset"
-target in Makefile.svn before trying to rebuild again. If, in the
-extreme case, you want to remove everything including the installed
-binaries effectively returning to the starting point, use the "nuke"
-target.
+  $ make nuke
 
 Extended usage
 ==============