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

[PATCH] Book: fix incorrect grammar, awkward phrasing

From: Michael W Thelen <thelenm_at_cs.utah.edu>
Date: 2004-05-21 08:26:00 CEST

This patch fixes some incorrect and awkward phrases in the book.
(Getting into more subjective territory here, but I think all these
changes are improvements.)

-- Mike

Log:
Fix incorrect grammar and awkward phrasing in the book.

* doc/book/book/appb.xml
  (svn-ap-b-sect-1.2.1): Insert a missing "a", and complete an incomplete
  phrase. Also break up a run-on sentence.
  (svn-ap-b-sect-1.2.8): Remove "which" that breaks the flow of the sentence.

* doc/book/book/ch03.xml
  (svn-ch-3-sect-4.2): Fix an awkward sentence by removing an unnecessary
  parenthetical phrase.
  (svn-ch-3-sect-4.3.1): Change "of file" to "of the file".

* doc/book/book/ch05.xml
  (svn-ch-5-sect-3.1.3): Remove an unnecessary "really" and a redundant "at
  this point". Rewrite several awkward sentences.

* doc/book/book/ch06.xml
  (svn-ch-6-sect-3.3): Change "as user" to "as the user".
  (svn-ch-6-sect-4): Remove unnecessary "which".
  (svn-ch-6-sect-4.4.2): Change "user" to "the user", and change a few other
  awkward phrases.

* doc/book/book/ch07.xml
  (svn-ch-7-sect-1.1): Remove unnecessary "again"
  (svn-ch-7-sect-1.3.1): Fix an incomplete sentence, and change "semi-colon
  delimited" to "semicolon-delimited".
  (svn-ch-7-sect-2.2): Change "lossage" to "loss".
  (svn-ch-7-sect-2.3.3): Break up run-on sentence with a colon.

* doc/book/book/ch08.xml
  (svn-ch-8-dia-2): Change "Revisioning" to "Versioning".
  (svn-ch-8-sect-1.1, svn-ch-8-sect-1.2.1, svn-ch-8-sect-1.2.3): Add a few
  words to make sentences read better.
  (svn-ch-8-sect-6.4): Remove redundant "actually".

* doc/book/book/ch09.xml
  (svn-ch-9-sect-1.2): Change "in working copy" to "in your working copy".
  Capitalize "id" where it occurs. Add a few missing words and punctuation.
  (svn-ch-9-sect-3.2): Fix a misleading sentence: svnlook propget shows the
  property values of a file, not the value of the file itself.

Index: doc/book/book/appb.xml
===================================================================
--- doc/book/book/appb.xml (revision 9813)
+++ doc/book/book/appb.xml (working copy)
@@ -42,10 +42,10 @@
           lost. If your process accesses the repository directly
           (mod_dav_svn, svnlook, svnadmin, or if you access a
           <literal>file://</literal> URL), then it's using Berkeley DB to
- access your data. Berkeley DB is journaling system, meaning that it
- logs everything it is about to do before it does so. If
- your process is interrupted (kill signal or segfault), then
- a lockfile is left behind, along with a logfile describing
+ access your data. Berkeley DB is a journaling system, meaning
+ that it logs everything it is about to do before it does so. If
+ your process is interrupted (e.g. by a kill signal or segfault),
+ then a lockfile is left behind, along with a logfile describing
           unfinished business. Any other process that attempts to
           access the database will just hang, waiting for the lockfile
           to disappear. To awaken your repository, you need to ask
@@ -54,8 +54,8 @@
           consistent.</para>
 
         <para>Make sure you run this command as the user that owns and
- manages the database, and not as root, else it will leave
- root-owned files in the db directory which cannot be opened
+ manages the database, not as root, or else it will leave
+ root-owned files in the db directory. These files cannot be opened
           by the non-root user that manages the database, which is
           typically either you or your Apache process. Also be sure
           to have the correct umask set when you run recover, since
@@ -236,7 +236,7 @@
         
         <para>Subversion uses a plugin system to allow access to
           repositories. Currently there are three of these plugins:
- ra_local allows access to a local repository, ra_dav which
+ ra_local allows access to a local repository, ra_dav
           allows access to a repository via WebDAV, and ra_svn allows
           local or remote access via the svnserve server. When you
           attempt to perform an operation in subversion, the program
Index: doc/book/book/ch03.xml
===================================================================
--- doc/book/book/ch03.xml (revision 9813)
+++ doc/book/book/ch03.xml (working copy)
@@ -583,9 +583,9 @@
         that you will use here are <command>svn add</command>,
         <command>svn delete</command>, <command>svn copy</command>,
         and <command>svn move</command>. However, if you are merely
- editing a file (or files) that is already in Subversion, you
- may not need to use any of these commands until you commit.
- Changes you can make to your working copy:</para>
+ editing files that are already in Subversion, you may not need
+ to use any of these commands until you commit. Changes you can
+ make to your working copy:</para>
       
       <variablelist>
         
@@ -854,7 +854,7 @@
           <varlistentry>
             <term><computeroutput>M file</computeroutput></term>
             <listitem>
- <para>The contents of file <filename>file</filename> have
+ <para>The contents of the file <filename>file</filename> have
                 been modified.</para>
             </listitem>
           </varlistentry>
Index: doc/book/book/ch05.xml
===================================================================
--- doc/book/book/ch05.xml (revision 9813)
+++ doc/book/book/ch05.xml (working copy)
@@ -1048,7 +1048,7 @@
         <para>Since Subversion stores everything in an opaque database
           system, attempting manual tweaks is unwise, if not quite
           difficult. And once data has been stored in your
- repository, Subversion generally doesn't really provide an
+ repository, Subversion generally doesn't provide an
           easy way to remove that data.
           <footnote>
             <para>That, by the way, is a <emphasis>feature</emphasis>,
@@ -1135,8 +1135,8 @@
           so on. But sometimes after new revisions start flying in,
           you rethink your layout and would like to make some changes.
           A common change is the decision to move multiple projects
- which are sharing a single repository into a single
- repository for each project.</para>
+ which are sharing a single repository into separate
+ repositories for each project.</para>
 
         <para>Our imaginary repository contains three projects:
           <literal>calc</literal>, <literal>calendar</literal>, and
@@ -1187,7 +1187,7 @@
 </screen>
 
         <para>At this point, you have to make a decision. Each of
- your dumpfiles at this point will create a valid repository,
+ your dumpfiles will create a valid repository,
           but will preserve the paths exactly as they were in the
           original repository. This means that even though you would
           have a repository solely for your <literal>calc</literal>
@@ -1288,11 +1288,11 @@
 &hellip;
 </screen>
 
- <para>If the paths lack leading slashes, you should not
+ <para>If the paths have leading slashes, you should
           include leading slashes in the paths you pass to
           <command>svndumpfilter include</command> and
- <command>svndumpfilter exclude</command> (and if they do,
- you should). Further, if your dumpfile has an inconsistent
+ <command>svndumpfilter exclude</command> (and if they don't,
+ you shouldn't). Further, if your dumpfile has an inconsistent
           usage of leading slashes for some reason,
           <footnote>
             <para>While <command>svnadmin dump</command> has a
@@ -1300,8 +1300,8 @@
               them&mdash;other programs which generate dump data might
               not be so consistent.</para>
           </footnote>
- you should probably normalize those paths to either all
- have, or all lack, leading slashes.</para>
+ you should probably normalize those paths so they all
+ have, or lack, leading slashes.</para>
 
         <para>Also, copied paths can give you some trouble.
           Subversion supports copy operations in the repository, where
Index: doc/book/book/ch06.xml
===================================================================
--- doc/book/book/ch06.xml (revision 9813)
+++ doc/book/book/ch06.xml (working copy)
@@ -720,15 +720,15 @@
 
       <para>What's happening here is that the Subversion client is
         invoking a local <command>ssh</command> process, connecting to
- <literal>host.example.com</literal>, authenticating as user
+ <literal>host.example.com</literal>, authenticating as the user
         <literal>harry</literal>, then spawning a private
         <command>svnserve</command> process on the remote machine,
- running as user <literal>harry</literal>. The
+ running as the user <literal>harry</literal>. The
         <command>svnserve</command> command is being invoked in tunnel
         mode (<option>-t</option>) and all network protocol is being
         <quote>tunneled</quote> over the encrypted connection by
         <command>ssh</command>, the tunnel-agent.
- <command>svnserve</command> is aware that it's running as user
+ <command>svnserve</command> is aware that it's running as the user
         <literal>harry</literal>, and if the client performs a commit,
         the authenticated username will be attributed as the author of
         the new revision.</para>
@@ -824,7 +824,7 @@
       writing&mdash;capabilities. The result is a standardized,
       robust system that is conveniently packaged as part of the
       Apache 2.0 software, is supported by numerous operating systems
- and third-party products, and which doesn't require network
+ and third-party products, and doesn't require network
       administrators to open up yet another custom port.
       <footnote>
         <para>They really hate doing that.</para>
@@ -1393,7 +1393,7 @@
           to your <literal>&lt;Location&gt;</literal> block. Using
           our previous example, this would mean that only clients that
           claimed to be either <literal>harry</literal> or
- <literal>sally</literal>, and which provided the correct
+ <literal>sally</literal>, and provided the correct
           password for their respective username, would be allowed to
           do anything with the Subversion repository:</para>
     
@@ -1596,7 +1596,7 @@
 
         <para>The syntax of the access file is the same familiar one
           used by <command>svnserve.conf</command> and the runtime
- configuration files. Lines that start with hash
+ configuration files. Lines that start with a hash
           (<literal>#</literal>) are ignored. In its simplest form,
           each section names a repository and path within it, and the
           authenticated usernames are the option names within each
@@ -1625,14 +1625,14 @@
 sally = r
 </screen>
 
- <para>In this first example, user <literal>harry</literal> has
+ <para>In this first example, the user <literal>harry</literal> has
           full read and write access on the
           <filename>/branches/calc/bug-142</filename> directory in the
- <literal>calc</literal> repository, but user
+ <literal>calc</literal> repository, but the user
           <literal>sally</literal> has read-only access. Any other
           users are blocked from accessing this directory.</para>
 
- <para>Of course, permissions <quote>inherit</quote> from
+ <para>Of course, permissions are inherited from
           parent to child directory. That means that we can specify a
           subdirectory with a different access policy for
           Sally:</para>
@@ -1687,7 +1687,7 @@
           all repositories world readable to all users, whether you're
           using <literal>SVNPath</literal> or
           <literal>SVNParentPath</literal>. Once all users have
- read-access to the repositor(ies), you can give explicit
+ read-access to the repositories, you can give explicit
           <literal>rw</literal> permission to certain users on specific
           subdirectories within specific repositories.</para>
 
Index: doc/book/book/ch07.xml
===================================================================
--- doc/book/book/ch07.xml (revision 9813)
+++ doc/book/book/ch07.xml (working copy)
@@ -99,7 +99,7 @@
         program have the final word on behavior. On Unix-like
         platforms, the system-wide configuration area is expected to be
         the <filename>/etc/subversion</filename> directory; on Windows
- machines, it again looks for a <filename>Subversion</filename>
+ machines, it looks for a <filename>Subversion</filename>
         directory inside the common Application Data location (again,
         as specified by the Windows Registry). Unlike the per-user
         case, the <command>svn</command> program does not attempt to
@@ -378,8 +378,9 @@
           <varlistentry>
             <term><literal>ssl-authority-files</literal></term>
             <listitem>
- <para>A semi-colon delimited list of paths to files containing
- certificates of the certificate authorities (or CAs) that
+ <para>This is a semicolon-delimited list of paths to files
+ containing certificates of the certificate authorities
+ (or CAs) that
                 are accepted by the Subversion client when accessing the
                 repository over HTTPS.</para>
             </listitem>
@@ -924,7 +925,7 @@
           Since the properties aren't versioned, you run the risk of
           losing information if you aren't careful with your edits.
           The repository administrator can setup methods to protect
- against this lossage, but by default, modification of
+ against this loss, and by default, modification of
           unversioned properties is disabled.</para>
 
       </sidebar>
@@ -1226,8 +1227,8 @@
 
         <para>In this example, you have made some property
           modifications to <filename>button.c</filename>, but in your
- working copy you also have some unversioned files, in this
- case, the latest <filename>calculator</filename> program
+ working copy you also have some unversioned files:
+ the latest <filename>calculator</filename> program
           that you've compiled from your source code, a source file
           named <filename>data.c</filename>, and a set of debugging
           output log files. Now, you know that your build system
Index: doc/book/book/ch08.xml
===================================================================
--- doc/book/book/ch08.xml (revision 9813)
+++ doc/book/book/ch08.xml (working copy)
@@ -293,7 +293,7 @@
         added dimension to the Subversion filesystem universe.</para>
 
       <figure id="svn-ch-8-dia-2">
- <title>Revisioning time&mdash;the third dimension!</title>
+ <title>Versioning time&mdash;the third dimension!</title>
         <graphic fileref="images/ch08dia2.png"/>
       </figure>
 
@@ -336,7 +336,7 @@
         repository layer because they have hooks associated with them.
         In the future, other events may be wrapped by the repository
         API. All of the remaining filesystem interaction will
- continue to occur directly with libsvn_fs API, though.</para>
+ continue to occur directly via the libsvn_fs API, though.</para>
 
       <para>For example, here is a code segment that illustrates the
         use of both the repository and filesystem interfaces to create
@@ -615,8 +615,8 @@
           communications with the Apache server (whose own mod_ssl can
           <quote>speak the language</quote>). Also, both Neon itself
           and Apache's mod_deflate can understand the
- <quote>deflate</quote> algorithm (the same used by the PKZIP
- and gzip programs), so requests can be sent in smaller,
+ <quote>deflate</quote> algorithm (the same one used by the
+ PKZIP and gzip programs), so requests can be sent in smaller,
           compressed chunks across the wire. Other complex features
           that Subversion hopes to support in the future include the
           ability to automatically handle server-specified redirects
@@ -672,8 +672,8 @@
           repository and filesystem libraries, so no network
           communication is required at all.</para>
 
- <para>Subversion requires the server name included as part of
- the <literal>file:</literal> URL be either
+ <para>Subversion requires that the server name included as part
+ of the <literal>file:</literal> URL be either
           <literal>localhost</literal> or empty, and that there be no
           port specification. In other words, your URLs should look
           like either
@@ -1644,7 +1644,7 @@
 
       <para>In the best-case scenario, you will have actually added
         appropriate tests to that test suite which verify that your
- proposed changes actually work as expected. In fact,
+ proposed changes work as expected. In fact,
         sometimes the best contribution a person can make is solely
         the addition of new tests. You can write regression tests for
         functionality that currently works in Subversion as a way to
Index: doc/book/book/ch09.xml
===================================================================
--- doc/book/book/ch09.xml (revision 9813)
+++ doc/book/book/ch09.xml (working copy)
@@ -2522,7 +2522,7 @@
 
           <para>This removes properties from files, directories, or
             revisions. The first form removes versioned properties
- in working copy, while the second removes unversioned
+ in your working copy, while the second removes unversioned
             remote properties on a repository revision.</para>
         </refsect1>
 
@@ -2741,7 +2741,7 @@
 
           <para>Lists all properties on files, directories, or
             revisions. The first form lists versioned properties in
- working copy, while the second lists unversioned remote
+ your working copy, while the second lists unversioned remote
             properties on a repository revision.</para>
         </refsect1>
 
@@ -3303,7 +3303,7 @@
             <varlistentry>
               <term>' '</term>
               <listitem>
- <para>Item is child of its parent directory.</para>
+ <para>Item is a child of its parent directory.</para>
               </listitem>
             </varlistentry>
             
@@ -4379,7 +4379,7 @@
       
       <para>Switches in <command>svnlook</command> are global, just
         like in <command>svn</command> and
- <command>svnadmin</command>, however, most switches only
+ <command>svnadmin</command>; however, most switches only
         apply to one subcommand since the functionality of
         <command>svnlook</command> is (intentionally) limited in
         scope.</para>
@@ -4410,7 +4410,7 @@
           <term><option>--transaction</option>
             (<option>-t</option>)</term>
           <listitem>
- <para>Specify a particular transaction id that you wish to
+ <para>Specify a particular transaction ID that you wish to
               examine. </para>
           </listitem>
         </varlistentry>
@@ -4912,8 +4912,8 @@
         <refsect1>
           <title>Examples</title>
 
- <para>This shows the value of the file
- <filename>/trunk/sandwich</filename> in the
+ <para>This shows the value of the <quote>seasonings</quote> property
+ on the file <filename>/trunk/sandwich</filename> in the
             <literal>HEAD</literal> revision:</para>
 
           <screen>
@@ -4998,7 +4998,7 @@
 
           <para>Print the tree, starting at <replaceable>PATH_IN_REPOS</replaceable> (if
             supplied, at the root of the tree otherwise), optionally
- showing node revision ids.</para>
+ showing node revision IDs.</para>
         </refsect1>
 
         <refsect1>

-- 
Michael W. Thelen
The word 'politics' is derived from the word 'poly', meaning 'many', and the
word 'ticks', meaning 'blood sucking parasites'.
                -- Larry Hardiman

Received on Fri May 21 08:27:42 2004

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

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.