[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Comments on book

From: Tim Moloney <moloney_at_mrsl.com>
Date: 2002-12-16 16:48:08 CET

It had been a while since I read the subversion documentation so
I read the new book this weekend to catch up on things.

First, excellent work.

Second, I found a few nits that I thought I'd point out. The
attached patch file is *not* meant to be applied. It is just
a conveniently way to precisely locate the areas that I wanted
to point out.

Finally, thanks for the great software and documentation. =)

-- 
Tim Moloney
ManTech Real-time Systems Laboratory
2015 Cattlemen Road                             \     /
Sarasota, FL  34232                     .________\(O)/________.
(941) 377-6775 x208                        '  '  O(.)O  '  '

Index: doc/book/book/ch02.xml
===================================================================
--- doc/book/book/ch02.xml (revision 4134)
+++ doc/book/book/ch02.xml (working copy)
@@ -526,7 +526,7 @@
           file should eventually be updated, to make it current with
           the public revision. A <command>svn commit</command> of the
           file will do nothing, and a <command>svn update</command> of
- the file fold the latest changes into your working
+ the file will fold the latest changes into your working
           copy.</para></listitem>
         </varlistentry>
         
Index: doc/book/book/ch03.xml
===================================================================
--- doc/book/book/ch03.xml (revision 4134)
+++ doc/book/book/ch03.xml (working copy)
@@ -703,6 +703,8 @@
     S ./stuff/squawk # this file or dir has been switched to a branch
         </screen>
       
+<!-- In this description, the word "column" has a different meaning... -->
+
         <para>In this output format <command>svn status</command>
           prints five columns of characters, followed by several
           whitespace characters, followed by a file or directory name.
@@ -870,6 +872,8 @@
                 44 36 harry ./stuff/things/gloo.c
         </screen>
            
+<!-- ... than the word "column" in this description. -->
+
         <para>This is the <quote>long form</quote> output of
           <command>svn status</command>. The first column remains
           same, but the second column shows the working-revision of
Index: doc/book/book/ch04.xml
===================================================================
--- doc/book/book/ch04.xml (revision 4134)
+++ doc/book/book/ch04.xml (working copy)
@@ -99,7 +99,9 @@
 
     <para>Let's say that you've been given the task of performing a
       radical reorganization of the project. It will take a long time
- to calc, and will affect all the files in the project. The
+ to
+<!-- Are words missing here? Perhaps "reorganize" or "do this to"? -->
+ calc, and will affect all the files in the project. The
       problem here is that you don't want to interfere with Sally, who
       is in the process of fixing small bugs here and there. She's
       depending on the fact that the latest version of the project is
Index: doc/book/book/ch07.xml
===================================================================
--- doc/book/book/ch07.xml (revision 4134)
+++ doc/book/book/ch07.xml (working copy)
@@ -789,7 +789,7 @@
       underscore (<literal>"__"</literal>). Functions private a given
       source file have no special prefixing, and are declared
       <literal>static</literal>. Of course, a compiler isn't
- iterested in these naming conventions, but they definitely help
+ interested in these naming conventions, but they definitely help
       to clarify the scopy of a given function or datatype.</para>
 
     <!-- ***************************************************************** -->
@@ -903,7 +903,10 @@
 
       <para>Let's look at an example that uses Subversion's Python
         SWIG bindings. Our example will do the same thing as our last
- example. Note the difference in size and complexity of the
+ example.
+<!-- It appears that things have been rearranged since the referenced
+ example is now after this one. -->
+ Note the difference in size and complexity of the
         function this time!</para>
 
       <example id="svn-ch-7-sect-2.3-ex-1">

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Mon Dec 16 16:49:04 2002

This is an archived mail posted to the Subversion Dev mailing list.