[svnbook commit] r2834 - trunk/src/en/book

sussman noreply at red-bean.com
Sun Aug 12 14:36:56 CDT 2007


Author: sussman
Date: Sun Aug 12 14:36:55 2007
New Revision: 2834

Log:
Update the 'quickstart' appendix for svn 1.4 book.

* src/en/book/appa-quickstart.xml
     - Reword some things.
     - Take some suggestions from offby1's review.
     - Point out that one may need both the svn tarball and the
       svn-deps tarball to build.



Modified:
   trunk/src/en/book/appa-quickstart.xml

Modified: trunk/src/en/book/appa-quickstart.xml
==============================================================================
--- trunk/src/en/book/appa-quickstart.xml	(original)
+++ trunk/src/en/book/appa-quickstart.xml	Sun Aug 12 14:36:55 2007
@@ -48,23 +48,32 @@
       Subversion.</para>
 
     <para>Alternately, you can build Subversion directly from source
-      code.  From the Subversion website, download the latest
-      source-code release.  After unpacking it, follow the
-      instructions in the <filename>INSTALL</filename> file to build
-      it.  Note that a released source package contains everything you
-      need to build a command-line client capable of talking to a
-      remote repository (in particular, the apr, apr-util, and neon
-      libraries).  But optional portions of Subversion have many other
-      dependencies, such as Berkeley DB and possibly Apache httpd.  If
-      you want to do a complete build, make sure you have all of the
-      packages documented in the <filename>INSTALL</filename>
-      file.</para>
+      code, though it's not always an easy task. (If you're not
+      experienced at building open source software packages, you're
+      probably better off downloading a binary distribution instead!)
+      From the Subversion website, download the latest source-code
+      release.  After unpacking it, follow the instructions in
+      the <filename>INSTALL</filename> file to build it.  Note that a
+      released source package may not contain everything you need to
+      build a command-line client capable of talking to a remote
+      repository.  Starting with Subversion 1.4 and later, the
+      libraries Subversion depends on (apr, apr-util, and neon) are
+      distributed in a separate source package suffixed
+      with <filename>-deps</filename>.  These libraries are now common
+      enough that they may already be installed on your system.  If
+      not, you'll need to unpack the dependency package into the same
+      directory where you unpacked the main Subversion source.
+      Regardless, it's possible that you may want to fetch other
+      optional dependencies such as Berkeley DB and possibly Apache
+      httpd.  If you want to do a complete build, make sure you have
+      all of the packages documented in
+      the <filename>INSTALL</filename> file.</para>
 
     <para>If you're one of those folks that likes to use bleeding-edge
       software, you can also get the Subversion source code from the
       Subversion repository in which it lives.  Obviously, you'll need
       to already have a Subversion client on hand to do this.  But
-      once you do, you can checkout a working copy of the Subversion source
+      once you do, you can check out a working copy of the Subversion source
       repository from <ulink url="http://svn.collab.net/repos/svn/trunk/"/>:
       <footnote>
         <para>Note that the URL checked out in the example above
@@ -84,16 +93,16 @@
 …
 </screen>
 
-    <para>The above command will checkout the bleeding-edge, latest
-      version of the Subversion source code into a subdirectory
+    <para>The above command will create a working copy of the latest
+      (unreleased) Subversion source code into a subdirectory
       named <filename>subversion</filename> in your current working
-      directory.  Obviously, you can adjust that last argument as
-      you see fit.  Regardless of what you call the new working copy
-      directory, though, after this operation completes, you will
-      now have the Subversion source code.  Of course, you will
-      still need to fetch a few helper libraries (apr, apr-util,
-      etc.)—see the <filename>INSTALL</filename> file in the
-      top level of the working copy for details.</para>
+      directory.  You can adjust that last argument as you see fit.
+      Regardless of what you call the new working copy directory,
+      though, after this operation completes, you will now have the
+      Subversion source code.  Of course, you will still need to fetch
+      a few helper libraries (apr, apr-util, etc.)—see
+      the <filename>INSTALL</filename> file in the top level of the
+      working copy for details.</para>
 
   </sect1>
 
@@ -110,17 +119,20 @@
         Flight attendants, prepare for take-off….</quote></para>
     </blockquote>
 
-    <para>The following is a very high-level tutorial which will walk
-      you through some basic Subversion configuration and operation.
-      By the time you complete the tutorial, you should have a basic
-      understanding of Subversion's typical usage.</para>
+    <para>What follows is a quick tutorial that walks you through some
+      basic Subversion configuration and operation.  When you finish
+      it, you should have a basic understanding of Subversion's
+      typical usage.</para>
 
     <note>
       <para>The examples used in this appendix assume that you have
         <command>svn</command>, the Subversion command-line client,
         and <command>svnadmin</command>, the administrative tool,
-        ready to go.  It also assumes you are using Subversion 1.2 or
-        later (run <command>svn --version</command> to check.)</para>
+        ready to go on a Unix-like operating system.  (This tutorial
+        also works at the Windows commandline prompt, assuming you
+        make some obvious tweaks.)  We also assume you are using
+        Subversion 1.2 or later (run <command>svn --version</command>
+        to check.)</para>
     </note>
 
     <para>Subversion stores all versioned data in a central
@@ -157,7 +169,7 @@
     <para>In this example, we assume that you already have some sort
       of project (a collection of files and directories) that you wish
       to import into your newly created Subversion repository.  Begin
-      by organizing them into a single directory
+      by organizing your data into a single directory
       called <filename>myproject</filename> (or whatever you wish).
       For reasons that will be clear later (see
       <xref linkend="svn.branchmerge"/>), your project's tree
@@ -258,8 +270,10 @@
       linkend="svn.serverconfig"/> to learn about the different sorts of
       server processes available and how to configure them.</para>
 
-    <para>### TODO:  Let's make this into a full tutorial, rather than
+    <!--
+    <para>### TODO: Let's make this into a full tutorial, rather than
               simply referring off to other sections. ###</para>
+      -->
 
   </sect1>
 




More information about the svnbook-dev mailing list