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

Re: [PATCH] Book fixes: typos, grammar, consistency

From: Michael W Thelen <thelenm_at_cs.utah.edu>
Date: 2004-05-12 05:07:57 CEST

* Michael W Thelen <thelenm@cs.utah.edu> [2004-05-06 02:51]:
> I apologize in advance for this large patch. If you would rather I
> break it up into smaller chunks, I can do that.

I'm thinking that this patch just contained too much, so I've decided to
break it up. Hopefully that will make it easier to review, and clearer
exactly what each of the various changes are doing. To start, here is
the portion of the patch that just fixes obvious problems such as typos,
missing words, missing punctuation, etc.

Fix typos, missing words, and missing punctuation.

* doc/book/book/appb.xml, doc/book/book/appc.xml,
  doc/book/book/appd.xml, doc/book/book/ch00.xml,
  doc/book/book/ch03.xml, doc/book/book/ch04.xml,
  doc/book/book/ch05.xml, doc/book/book/ch06.xml,
  doc/book/book/ch07.xml, doc/book/book/ch08.xml,
  doc/book/book/ch09.xml: Fix minor nits.

Index: doc/book/book/appb.xml
--- doc/book/book/appb.xml (revision 9688)
+++ doc/book/book/appb.xml (working copy)
@@ -22,7 +22,7 @@
       having here, look at the most up-to-date version of the FAQ on
       Subversion's main website. If you're still stuck, then send
       mail to <email>users@subversion.tigris.org</email> with a
- detailed description of the problem you're having
+ detailed description of the problem you're having.
       <footnote><para>Remember that the amount of detail you provide
       about your setup and your problem is directly proportional to
       the likelihood of getting an answer from the mailing list.
@@ -83,7 +83,7 @@
           logs everything it is about to do before it does so. If
           <command>svn</command> is interrupted while performing an
           action, then one or more lockfiles are left behind, along
- with log files describing then unfinished
+ with log files describing the unfinished
           actions. (<command>svn status</command> will show an
           <literal>L</literal> next to locked directories.)</para>
@@ -156,7 +156,7 @@
         <title>Under Windows XP, the Subversion server sometimes
           seems to send out corrupted data.</title>
- <para>You need to install Window XP Service Pack 1 to fix a
+ <para>You need to install Windows XP Service Pack 1 to fix a
           TCP/IP stack bug in the operating system. You can get all
           sorts of information about that Service Pack at <systemitem
@@ -459,7 +459,7 @@
           like <command>svn diff</command>, <command>svn
           merge</command>, and <command>svn cat</command> ought to
           understand and follow renames, but don't yet do this. It's
- scheduled as post-1.0 feature. For example, if you ask
+ scheduled as a post-1.0 feature. For example, if you ask
           <command>svn diff</command> to compare two earlier versions
           of <filename>/branches/mybranch/foo.c</filename>, the
           command will not automatically understand that the task
Index: doc/book/book/appc.xml
--- doc/book/book/appc.xml (revision 9688)
+++ doc/book/book/appc.xml (working copy)
@@ -77,7 +77,7 @@
- <para>This is same idea present in
+ <para>This is the same idea present in
               Subversion&mdash;metadata attached to files and
               collections. A client can list or retrieve properties
               attached to a resource with the new
@@ -162,7 +162,7 @@
             <literal>CHECKOUT</literal>, <literal>PUT</literal>,
             <literal>CHECKIN</literal>. After each
             <literal>CHECKIN</literal>, a new VR is created, and
- edited VCR's contents now <quote>point to</quote> the
+ the edited VCR's contents now <quote>point to</quote> the
             latest VR. Each VCR has also has a <quote>history</quote>
             resource which tracks and orders its various VR
@@ -490,7 +490,7 @@
         Network Places.</para>
       <para>Most write operations work fine against an autoversioning
- mod_dav_svn server, but there are few problems:</para>
+ mod_dav_svn server, but there are a few problems:</para>
Index: doc/book/book/appd.xml
--- doc/book/book/appd.xml (revision 9688)
+++ doc/book/book/appd.xml (working copy)
@@ -49,7 +49,7 @@
         <term>RapidSVN (<systemitem
         <listitem><para>Cross-platform Subversion GUI, based on the
- WxPython libaries</para></listitem>
+ WxPython libraries</para></listitem>
Index: doc/book/book/ch00.xml
--- doc/book/book/ch00.xml (revision 9688)
+++ doc/book/book/ch00.xml (working copy)
@@ -132,7 +132,7 @@
           <para>Whether you're a user or administrator, eventually
             your project will grow larger. You're going to want to
             learn how to do more advanced things with Subversion, such
- as how to use branches and perform mergees (chapter 4),
+ as how to use branches and perform merges (chapter 4),
             how to use Subversion's property support, how to configure
             runtime options (chapter 7), and other things. Chapters 4
             and 7 aren't vital at first, but be sure to read them once
Index: doc/book/book/ch03.xml
--- doc/book/book/ch03.xml (revision 9688)
+++ doc/book/book/ch03.xml (working copy)
@@ -833,7 +833,7 @@
             <term><computeroutput>C file</computeroutput></term>
- <para><filename>file_or_dir</filename> is in a state of
+ <para>The file <filename>file</filename> is in a state of
                 conflict. That is, changes received from the server
                 during an update overlap with local changes that you
                 have in your working copy. You must resolve this
Index: doc/book/book/ch04.xml
--- doc/book/book/ch04.xml (revision 9688)
+++ doc/book/book/ch04.xml (working copy)
@@ -93,7 +93,7 @@
     <para>As before, assume that Sally and you both have working
       copies of the <quote>calc</quote> project. Specifically, you
       each have a working copy of <filename>/calc/trunk</filename>.
- All the files for the project are in this subdirectory (rather
+ All the files for the project are in this subdirectory rather
       than in <filename>/calc</filename> itself, because your team has
       decided that <filename>/calc/trunk</filename> is where the
       <quote>main line</quote> of development is going to take
Index: doc/book/book/ch05.xml
--- doc/book/book/ch05.xml (revision 9688)
+++ doc/book/book/ch05.xml (working copy)
@@ -1072,7 +1072,7 @@
           dump data, and <command>svnadmin load</command> to populate
           a new repository with it (see <xref
           linkend="svn-ch-5-sect-3.5"/>). The great thing about the
- human-readibility aspect of the dump format is that, if you
+ human-readability aspect of the dump format is that, if you
           aren't careless about it, you can manually inspect and
           modify it. Of course, the downside is that if you have two
           years' worth of repository activity encapsulated in what is
@@ -1194,7 +1194,7 @@
           project, that repository would still have a top-level
           directory named <filename>calc</filename>. If you want
           your <filename>trunk</filename>, <filename>tags</filename>,
- and <filename>branches</filename> directories to live in
+ and <filename>branches</filename> directories to live in the
           root of your repository, you might wish to edit your
           dumpfiles, tweaking the <literal>Node-path</literal> and
           <literal>Copyfrom-path</literal> headers to no longer have
@@ -1466,7 +1466,7 @@
           <command>db_recover</command> utility.</para>
         <para>There are still a few Berkeley DB utilities that you
- mind find useful. The <command>db_dump</command> and
+ might find useful. The <command>db_dump</command> and
           <command>db_load</command> programs write and read,
           respectively, a custom file format which describes the keys
           and values in a Berkeley DB database. Since Berkeley
@@ -1551,7 +1551,7 @@
         triggered, and therefore must be setup to accept changes of
         this nature. But an administrator can get around these
         protections by passing the <option>--bypass-hooks</option>
- option to <command>svnadmin setlog</command> command.</para>
+ option to the <command>svnadmin setlog</command> command.</para>
         <para>Remember, though, that by bypassing the hooks, you are
@@ -2087,7 +2087,7 @@
       <para>The dump format can also be used to merge the contents of
         several different repositories into a single repository. By
- using the <option>--parent-dir</option> of <command>svnadmin
+ using the <option>--parent-dir</option> option of <command>svnadmin
         load</command>, you can specify a new virtual root directory
         for the load process. That means if you have dumpfiles for
         three repositories, say <filename>calc-dumpfile</filename>,
@@ -2393,7 +2393,7 @@
         projects, you might want to arrange them in groups inside the
         repository, perhaps putting projects with similar goals or
         shared code in the same subdirectory, or maybe just grouping
- them alphabetically. Such an arrangment might look
+ them alphabetically. Such an arrangement might look
Index: doc/book/book/ch06.xml
--- doc/book/book/ch06.xml (revision 9688)
+++ doc/book/book/ch06.xml (working copy)
@@ -39,7 +39,7 @@
     <para>Apache is an extremely popular webserver; using the
       <command>mod_dav_svn</command> module, Apache can access a
- repository and make it available to clients via WebDAV/DeltaV
+ repository and make it available to clients via the WebDAV/DeltaV
       protocol, which is an extension of HTTP. In the other corner is
       <command>svnserve</command>: a small, standalone server
       program that speaks a custom protocol with clients. Table 6-1
@@ -429,7 +429,7 @@
       <para>Make sure <quote>svnowner</quote> is a user which has
- appopriate permissions to access your repositories. Now, when
+ appropriate permissions to access your repositories. Now, when
         a client connection comes into your server on port 3690,
         <command>inetd</command> will spawn an
         <command>svnserve</command> process to service it. </para>
@@ -819,7 +819,7 @@
       extension to HTTP 1.1 (see <systemitem
       class="url">http://www.webdav.org/</systemitem> for more
       information.) This protocol takes the ubiquitous HTTP protocol
- that is core of the World Wide Web, and adds
+ that is the core of the World Wide Web, and adds
       writing&mdash;specifically, versioned
       writing&mdash;capabilities. The result is a standardized,
       robust system that is conveniently packaged as part of the
@@ -1022,7 +1022,7 @@
       <para>Be sure that when you define your new
         <literal>Location</literal>, it doesn't overlap with other
         exported Locations. For example, if your main
- <literal>DocumentRoot</literal> to <filename>/www</filename>,
+ <literal>DocumentRoot</literal> is <filename>/www</filename>,
         do not export a Subversion repository in <literal>&lt;Location
         /www/repos&gt;</literal>. If a request comes in for the URI
         <filename>/www/repos/foo.c</filename>, Apache won't know
@@ -1125,7 +1125,7 @@
       <sect3 id="svn-ch-6-sect-4.3.1">
         <title>Basic HTTP Authentication</title>
- <para>The easiest way to authenticate an client is via the
+ <para>The easiest way to authenticate a client is via the
           HTTP Basic authentication mechanism, which simply uses a
           username and password to verify that a user is who she says
           she is. Apache provides an <command>htpasswd</command>
@@ -1714,8 +1714,8 @@
         <para>Groups can be granted access control just like users.
- Distinguish them with an ampersane (<literal>@</literal>)
- prefix:</para>
+ Distinguish them with an <quote>at sign</quote>
+ (<literal>@</literal>) prefix:</para>
@@ -1986,7 +1986,7 @@
       <para>It can be quite tricky to get a bunch of users with
         existing SSH accounts to share a repository without
         permissions problems. If you're confused about all the things
- that you (as an admininstrator) need to do on a Unix-like
+ that you (as an administrator) need to do on a Unix-like
         system, here's a quick checklist that resummarizes some of
         things discussed in this section:</para>
Index: doc/book/book/ch07.xml
--- doc/book/book/ch07.xml (revision 9688)
+++ doc/book/book/ch07.xml (working copy)
@@ -395,7 +395,7 @@
- <para>If host (or set of hosts) requries an SSL client
+ <para>If a host (or set of hosts) requires an SSL client
                 certificate, you'll normally be prompted for a path to
                 your certificate. By setting this variable to that
                 same path, Subversion will be able to find your client
@@ -1790,7 +1790,7 @@
       not affect what gets checked out as an external (though the
       relative local target subdirectory will, of course, move with
       renamed directory). This can be confusing&mdash;even
- frustrating&mdash;in certain situtations. For example, if you
+ frustrating&mdash;in certain situations. For example, if you
       use externals definitions on a directory in your
       <filename>/trunk</filename> development line which point to
       other areas of that same line, and then you use <command>svn
Index: doc/book/book/ch08.xml
--- doc/book/book/ch08.xml (revision 9688)
+++ doc/book/book/ch08.xml (working copy)
@@ -537,7 +537,7 @@
         <para>The libsvn_ra_dav library is designed for use by clients
           that are being run on different machines than the servers
- with which they communicating, specifically machines reached
+ with which they are communicating, specifically machines reached
           using URLs that contain the <literal>http:</literal> or
           <literal>https:</literal> protocol portions. To understand
           how this module works, we should first mention a couple of
@@ -728,7 +728,7 @@
         accomplish this, the library stores administrative information
         about each working copy directory within a special
         subdirectory. This subdirectory, named
- <filename>.svn</filename> is present in each working copy
+ <filename>.svn</filename>, is present in each working copy
         directory and contains various other files and directories
         which record state and provide a private workspace for
         administrative action. For those familiar with CVS, this
Index: doc/book/book/ch09.xml
--- doc/book/book/ch09.xml (revision 9688)
+++ doc/book/book/ch09.xml (working copy)
@@ -841,7 +841,7 @@
           <para>Recursively clean up the working copy, removing
- locks resuming unfinished operations. If you ever get a
+ locks and resuming unfinished operations. If you ever get a
             <quote>working copy locked</quote> error, run this
             command to remove stale locks and get your working copy
             into a usable state again. See <xref
@@ -2152,7 +2152,8 @@
           <para>You can avoid the clutter of the double dashed lines
- in your output by using the incremental switch:</para>
+ in your output by using the <option>--incremental</option>
+ switch:</para>
@@ -2179,7 +2180,7 @@
             <para>If you run <command>svn log</command> on a specific
               path and provide a specific revision and get no output
- at all</para>
+ at all:</para>
 $ svn log -r 20 http://svn.red-bean.com/untouched.txt
@@ -2561,7 +2562,7 @@
           <para>Delete a property from a file in your working
- copy</para>
+ copy:</para>
 $ svn propdel svn:mime-type some-script
@@ -3573,7 +3574,7 @@
           <para><command>svn update</command> brings changes from the
- repository into your working copy. If no revision given,
+ repository into your working copy. If no revision is given,
             it brings your working copy up-to-date with the
             <literal>HEAD</literal> revision. Otherwise, it
             synchronizes the working copy to the revision given by the
@@ -3755,7 +3756,7 @@
- <para>By default, when loading data into repository that
+ <para>By default, when loading data into a repository that
             already contains revisions, <command>svnadmin</command>
             will ignore the <literal>UUID</literal> from the dump
             stream. This switch will cause the repository's

-- Mike

Michael W. Thelen
Many would be cowards if they had courage enough.
                -- Thomas Fuller

Received on Wed May 12 05:09:49 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.