Hi all,
I apologize in advance for this large patch. If you would rather I
break it up into smaller chunks, I can do that. It contains typo and
grammar fixes throughout the Subversion book, as well as some changes to
make the use of certain phrases consistent (for example, "command-line"
and "commandline" have been changed to "command line"). I think in most
cases, the actual phrase isn't as important as consistency (i.e.
"command-line" would be just as good, if consistently used). I've tried
to make the log message as concise yet informative as I could. Please
let me know how it can be improved... and if necessary, tell me to
never, ever send such a large email again. :-)
-- Mike
[[[
Fix typos, grammar, phrase consistency, and various nits throughout the book.
Changes larger than a typo or grammar fix are detailed below.
* doc/book/book/appa.xml
Consistency fixes.
* doc/book/book/appb.xml
(svn-ap-b-sect-1.2.1): Break up a run-on sentence.
(svn-ap-b-sect-1.2.2): Remove "working-copy" arg from "svn cleanup" example,
since the command is being run from the top of the working copy.
* doc/book/book/appc.xml
Typo, consistency fixes.
* doc/book/book/appd.xml
Typo, consistency fixes.
* doc/book/book/ch00.xml
Consistency fixes.
* doc/book/book/ch01.xml
Consistency fixes.
* doc/book/book/ch02.xml
(svn-ch-2-sect-3.1): Change "ls -a" to "ls -A" since . and .. are not shown
in output.
* doc/book/book/ch03.xml
(svn-ch-3-sect-4): Change "revision 3678" to "revision 2499" for consistency
within the section.
(svn-ch-3-sect-4.2): Simplify "file (or files)" to just "files".
(svn-ch-3-sect-4.3.1): Change various instances of "file" to "the file"
for consistency, and fix erroneous "file_or_dir" to be "file".
(svn-ch-3-sect-4.4.1): Rewrite confusing sentences in the "you and your
collaborator, Sally" paragraph. Previously pointed out by Marcel Molina Jr.
<marcel@vernix.org>.
(svn-ch-3-sect-4.5): Add "(or -F)" after "--file" for consistency.
* doc/book/book/ch04.xml
(svn-ch-4-sect-2.1): Remove trailing slash from references to "trunk".
(svn-ch-4-sect-6.2): Remove . and .. from ls output since -a was not used.
* doc/book/book/ch05.xml
(svn-ch-5-sect-3.1.2): Change tense of some descriptions from third-person
singular to imperative, for consistency among descriptions in the section.
(svn-ch-5-sect-3.1.3): Remove redundant "really".
Rephrase "a single repository for each project" to "separate repositories
for each project".
Remove repeated phrase "at this point".
Change negation of "if the paths have leading slashes" so that the
parenthetical remark at the end of the sentence makes sense. Also rewrite
confusing last sentence in the same paragraph.
* doc/book/book/ch06.xml
(svn-ch-06-table-1): Uncapitalize "viewing" in "Web viewing" for
consistency.
(svn-ch-6-sect-3.3): Change various references to "user" into "the user".
(svn-ch-6-sect-4.4.2): Change awkward "inherit" into "are inherited".
Change "ampersane" to "at symbol" in referring to the @ symbol.
* doc/book/book/ch07.xml
(svn-ch-7-sect-1.3.1): Add "this is" to ssl-authority-files description for
consistency.
(svn-ch-7-sect-2.2): Change "lossage" to "loss", and change "but" to "and"
since the second clause is complementary, not contradictory.
(svn-ch-7-sect-2.3.3): Remove redundant "in this case", replace with colon.
* doc/book/book/ch08.xml
(svn-ch8-sect1.1-dia2): Change title from "Revisioning Time" to "Versioning
Time" since "revisioning" doesn't show up anywhere else in the book.
(svn-ch-8-sect-6.4): Remove repeated "actually".
* doc/book/book/ch09.xml
(svn-ch-9-sect-1.1): Change tense of some descriptions from imperative to
third-person singular, for consistency among descriptions in the section.
(svn-ch-9-sect-1.2): Change tense of some descriptions from third-person
singular to imperative, for consistency among descriptions in the section.
Change "working copy" to "your working copy" for consistency.
Remove "REPOS_PATH" from short description of "svnadmin create" because no
other short descriptions use symbol names for arguments.
Add missing mention of "seasonings" property in "svn propget" example.
Consistency fixes:
There were many phrases with inconsistent usage throughout the book.
The actual phrase doesn't matter as much as consistency. I tried to
make changes based on the more common usage of each phrase in the book.
Changes include:
"checkout" -> "check out" when used as a verb
"setup" -> "set up" when used as a verb
"url" -> "URL" when used in a sentence
"sub-directory" -> "subdirectory"
"codebase" -> "code base"
"log-message" -> "log message"
"plug-in" -> "plugin"
"standalone" -> "stand-alone"
"backend" -> "back-end"
"offline" -> "off-line"
"out of date" -> "out-of-date"
"BerkeleyDB" -> "Berkeley DB"
"commandline" -> "command line"
"command-line" -> "command line"
"webserver" -> "web server"
"UNIX" -> "Unix" (except in Fitz's acknowledgment)
]]]
Index: doc/book/book/appa.xml
===================================================================
--- doc/book/book/appa.xml (revision 9632)
+++ doc/book/book/appa.xml (working copy)
@@ -25,7 +25,7 @@
<title>Revision Numbers Are Different Now</title>
<para>In CVS, revision numbers are per-file. This is because CVS
- uses RCS as a backend; each file has a corresponding RCS file in
+ uses RCS as a back-end; each file has a corresponding RCS file in
the repository, and the repository is roughly laid out according
to the structure of your project tree.</para>
@@ -175,7 +175,7 @@
to send differences when committing, which CVS cannot do.</para>
<para>The last subcommand in the list is new; it will not only
- remove local mods, but it will un-schedule operations such as
+ remove local mods, but it will unschedule operations such as
adds and deletes. It's the preferred way to revert a file;
running <command>rm file; svn update</command> will still work, but
it blurs the purpose of updating. And, while we're on this
Index: doc/book/book/appb.xml
===================================================================
--- doc/book/book/appb.xml (revision 9632)
+++ 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.
@@ -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
@@ -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>
@@ -94,7 +94,7 @@
working copy:</para>
<screen>
-$ svn cleanup working-copy
+$ svn cleanup
</screen>
</sect3>
@@ -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
class="url">http://support.microsoft.com/default.aspx?scid=kb;EN-US;q317949</systemitem>.</para>
@@ -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
@@ -393,7 +393,7 @@
systems will block for high-quality randomness. You
probably need to configure the system to gather entropy from
sources such as hard-disk and network interrupts. Consult
- your system manpages, specifically
+ your system man pages, specifically
<command>random(4)</command> and
<command>rndcontrol(8)</command> on how to effect this
change. Another workaround is to compile APR against
@@ -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 9632)
+++ doc/book/book/appc.xml (working copy)
@@ -77,7 +77,7 @@
<varlistentry>
<term>Properties</term>
<listitem>
- <para>This is same idea present in
+ <para>This is the same idea present in
Subversion—metadata attached to files and
collections. A client can list or retrieve properties
attached to a resource with the new
@@ -132,7 +132,7 @@
<term>Per-resource versioning</term>
<listitem>
<para>
- Like CVS and other version-control systems, DeltaV
+ Like CVS and other version control systems, DeltaV
assumes that each resource has a potentially infinite
number of states. A client begins by placing a resource
under version control using 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
states.</para>
@@ -307,7 +307,7 @@
<listitem>
<para>
Send a custom <literal>REPORT</literal> request that
- describes the mixed-revision (and mixed-url) state of
+ describes the mixed-revision (and mixed-URL) state of
the working copy. The server sends a custom response
that describes which items need updating. The client
loops over the response, performing
@@ -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>
<itemizedlist>
Index: doc/book/book/appd.xml
===================================================================
--- doc/book/book/appd.xml (revision 9632)
+++ doc/book/book/appd.xml (working copy)
@@ -6,7 +6,7 @@
<para>Subversion's modular design (covered in <xref
linkend="svn-ch-8-sect-1"/>) and the availability of language
bindings (as described in <xref linkend="svn-ch-8-sect-2.3"/>)
- make it a likely candidate for use as an extension or backend to
+ make it a likely candidate for use as an extension or back-end to
other pieces of software. In this appendix, we'll briefly
introduce you to some of the many third-party tools that are
using Subversion functionality under-the-hood.</para>
@@ -49,7 +49,7 @@
<term>RapidSVN (<systemitem
class="url">http://rapidsvn.tigris.org/</systemitem>)</term>
<listitem><para>Cross-platform Subversion GUI, based on the
- WxPython libaries</para></listitem>
+ WxPython libraries</para></listitem>
</varlistentry>
<varlistentry>
@@ -185,7 +185,7 @@
<term>Kwiki (<systemitem
class="url">http://www.kwiki.org/</systemitem>)</term>
<listitem><para>Wiki with a Subversion backup
- backend</para></listitem>
+ back-end</para></listitem>
</varlistentry>
<varlistentry>
Index: doc/book/book/ch00.xml
===================================================================
--- doc/book/book/ch00.xml (revision 9632)
+++ doc/book/book/ch00.xml (working copy)
@@ -54,11 +54,11 @@
<para>This book is written for computer-literate folk who want to
use Subversion to manage their data. While Subversion runs on a
number of different operating systems, its primary user
- interface is command-line based. It is that command-line tool
+ interface is command line based. It is that command line tool
(<command>svn</command>) which is discussed and used in this
book. For consistency, the examples in this book assume the
reader is using a Unix-like operating system, and is relatively
- comfortable with Unix and command-line interfaces.</para>
+ comfortable with Unix and command line interfaces.</para>
<para>That said, the <command>svn</command> program also runs on
non-Unix platforms like Microsoft Windows. With a few minor
@@ -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
@@ -338,7 +338,7 @@
Subversion and CVS, with numerous suggestions on how to
break all the bad habits you picked up from years of
using CVS. Included are descriptions of Subversion
- revision numbers, versioned directories, offline
+ revision numbers, versioned directories, off-line
operations, <command>update</command>
vs. <command>status</command>, branches, tags, metadata,
conflict resolution, and authentication.</para>
Index: doc/book/book/ch01.xml
===================================================================
--- doc/book/book/ch01.xml (revision 9632)
+++ doc/book/book/ch01.xml (working copy)
@@ -214,7 +214,7 @@
big advantage in stability and interoperability, and
instant access to existing features provided by that
server—authentication, authorization, wire
- compression, and so on. A more lightweight, standalone
+ compression, and so on. A more lightweight, stand-alone
Subversion server process is also available. This server
speaks a custom protocol which can be easily tunneled over
SSH.</para>
@@ -317,7 +317,7 @@
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
+ 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
@@ -347,7 +347,7 @@
<varlistentry>
<term>svn</term>
<listitem>
- <para>The command-line client program.</para>
+ <para>The command line client program.</para>
</listitem>
</varlistentry>
@@ -385,7 +385,7 @@
<varlistentry>
<term>mod_dav_svn</term>
<listitem>
- <para>A plug-in module for the Apache HTTP Server, used to
+ <para>A plugin module for the Apache HTTP Server, used to
make your repository available to others over a
network.</para>
</listitem>
@@ -394,7 +394,7 @@
<varlistentry>
<term>svnserve</term>
<listitem>
- <para>A custom standalone server program, runnable as a
+ <para>A custom stand-alone server program, runnable as a
daemon process or invokable by SSH; another way to make
your repository available to others over a network.</para>
</listitem>
@@ -403,7 +403,7 @@
<para>Assuming you have Subversion installed correctly, you should
be ready to start. The next two chapters will walk you through
- the use of <command>svn</command>, Subversion's command-line client
+ the use of <command>svn</command>, Subversion's command line client
program.</para>
</sect1>
Index: doc/book/book/ch02.xml
===================================================================
--- doc/book/book/ch02.xml (revision 9632)
+++ doc/book/book/ch02.xml (working copy)
@@ -303,7 +303,7 @@
A calc/integer.c
A calc/button.c
-$ ls -a calc
+$ ls -A calc
Makefile integer.c button.c .svn/
</screen>
@@ -444,7 +444,7 @@
$ pwd
/home/sally/calc
-$ ls -a
+$ ls -A
.svn/ Makefile integer.c button.c
$ svn update
Index: doc/book/book/ch03.xml
===================================================================
--- doc/book/book/ch03.xml (revision 9632)
+++ doc/book/book/ch03.xml (working copy)
@@ -31,7 +31,7 @@
<para>Before reading on, here is the most important command you'll
ever need when using Subversion: <command>svn help</command>.
- The Subversion command-line client is
+ The Subversion command line client is
self-documenting—at any time, a quick <command>svn help
<subcommand></command> will describe the syntax, switches,
and behavior of the <command>subcommand</command>.</para>
@@ -329,7 +329,7 @@
A tools/dtd
A tools/dtd/dblite.dtd
…
-Checked out revision 3678.
+Checked out revision 2499.
</screen>
<para>Since Subversion uses a <quote>copy-modify-merge</quote>
@@ -577,9 +577,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>
@@ -825,7 +825,7 @@
<varlistentry>
<term><computeroutput>C file</computeroutput></term>
<listitem>
- <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
@@ -846,7 +846,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>
@@ -1380,14 +1380,12 @@
first time you attempt it, but with a little practice, it
can become as easy as falling off a bike.</para>
- <para>Here's an example. Let's say that, due to a
- miscommunication between you and your collaborator, Sally,
+ <para>Here's an example. Let's say that due to a
+ miscommunication, you and your collaborator, Sally,
both edit the file named <filename>sandwich.txt</filename>
at the same time. Sally commits her changes, and when you
- go to update your working copy, you get a conflict and we're
- going to have to edit <filename>sandwich.txt</filename> to
- resolve the conflicts. First, let's take a look at the
- file:</para>
+ go to update your working copy, you get a conflict.
+ First, let's take a look at the file:</para>
<screen>
$ cat sandwich.txt
@@ -1551,7 +1549,7 @@
<para>However, if you've been composing your log message as you
work, you may want to tell Subversion to get the message from
a file by passing the filename with the
- <option>--file</option> switch:</para>
+ <option>--file</option> (or <option>-F</option>) switch:</para>
<screen>
$ svn commit --file logmsg
Index: doc/book/book/ch04.xml
===================================================================
--- doc/book/book/ch04.xml (revision 9632)
+++ doc/book/book/ch04.xml (working copy)
@@ -92,7 +92,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
@@ -179,13 +179,13 @@
<screen>
$ cd bigwc
-$ svn copy trunk/ branches/my-calc-branch
+$ svn copy trunk branches/my-calc-branch
$ svn status
A + branches/my-calc-branch
</screen>
<para>In this case, the <command>svn copy</command> command
- recursively copies the <filename>trunk/</filename> working
+ recursively copies the <filename>trunk</filename> working
directory to a new working directory,
<filename>branches/my-calc-branch</filename>. As you can see
from the <command>svn status</command> command, the new
@@ -717,8 +717,8 @@
<para>What does this mean to you, the user? It means that
until the day Subversion grows this feature, you'll have to
track merge information yourself. The best place to do this
- is in the commit log-message. As demonstrated in the
- earlier example, it's recommended that your log-message
+ is in the commit log message. As demonstrated in the
+ earlier example, it's recommended that your log message
mention a specific revision number (or range of revisions)
that are being merged into your branch. Later on, you can
run <command>svn log</command> to review which changes your
@@ -922,7 +922,7 @@
…
</screen>
- <para>Aha! Since all branch-changes that happened between
+ <para>Aha! Since all branch changes that happened between
revisions 341 and 405 were previously merged to the trunk, you
now know that you want to merge only the branch changes after
that: revisions 406 through <literal>HEAD</literal>.</para>
@@ -1410,7 +1410,7 @@
<screen>
$ ls
-./ ../ my-working-copy/
+my-working-copy/
$ svn copy my-working-copy http://svn.example.com/repos/calc/tags/mytag
@@ -1419,7 +1419,7 @@
<para>Now there is a new directory in the repository,
<filename>/calc/tags/mytag</filename>, which is an exact
- snapshot of your working copy—mixed revisions, urls,
+ snapshot of your working copy—mixed revisions, URLs,
and all.</para>
<para>Other users have found interesting uses for this feature.
@@ -1429,7 +1429,7 @@
diff</command> and sending a patchfile (which won't capture
tree changes), you can instead use <command>svn copy</command>
to <quote>upload</quote> your working copy to a private area
- of the repository. Your collaborator can then either checkout
+ of the repository. Your collaborator can then either check out
a verbatim copy of your working copy, or use <command>svn
merge</command> to receive your exact changes.</para>
Index: doc/book/book/ch05.xml
===================================================================
--- doc/book/book/ch05.xml (revision 9632)
+++ doc/book/book/ch05.xml (working copy)
@@ -168,7 +168,7 @@
<para>Another great feature of Berkeley DB is <firstterm>hot
backups</firstterm>—the ability to backup the database
- environment without taking it <quote>offline</quote>. We'll
+ environment without taking it <quote>off-line</quote>. We'll
discuss how to backup your repository in <xref
linkend="svn-ch-5-sect-3.6"/>, but the benefits of being
able to make fully functional copies of your repositories
@@ -909,7 +909,7 @@
<varlistentry>
<term><literal>create</literal></term>
<listitem>
- <para>Creates a new Subversion repository.</para>
+ <para>Create a new Subversion repository.</para>
</listitem>
</varlistentry>
@@ -927,7 +927,7 @@
<varlistentry>
<term><literal>dump</literal></term>
<listitem>
- <para>Dumps the contents of the repository, bounded by a
+ <para>Dump the contents of the repository, bounded by a
given set of revisions, using a portable dump format.</para>
</listitem>
</varlistentry>
@@ -935,7 +935,7 @@
<varlistentry>
<term><literal>hotcopy</literal></term>
<listitem>
- <para>Makes a hot copy of a repository. You can run
+ <para>Make a hot copy of a repository. You can run
this command at any time and make a safe copy of the
repository, regardless if other processes are using
the repository.</para>
@@ -945,7 +945,7 @@
<varlistentry>
<term><literal>list-dblogs</literal></term>
<listitem>
- <para>Lists the paths of Berkeley DB log files
+ <para>List the paths of Berkeley DB log files
associated with the repository. This list includes
all log files—those still in use by Subversion, as
well as those no longer in use.</para>
@@ -955,7 +955,7 @@
<varlistentry>
<term><literal>list-unused-dblogs</literal></term>
<listitem>
- <para>Lists the paths of Berkeley DB log files
+ <para>List the paths of Berkeley DB log files
associated with, but no longer used by, the
repository. You may safely remove these log files from
the repository layout, possibly archiving them for use
@@ -967,7 +967,7 @@
<varlistentry>
<term><literal>load</literal></term>
<listitem>
- <para>Loads a set of revisions into a repository from a
+ <para>Load a set of revisions into a repository from a
stream of data that uses the same portable dump format
generated by the <literal>dump</literal> subcommand.</para>
</listitem>
@@ -1028,7 +1028,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>,
@@ -1052,7 +1052,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
@@ -1115,8 +1115,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
@@ -1167,14 +1167,14 @@
</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>
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
@@ -1221,7 +1221,7 @@
now-empty revision could be considered uninteresting or even
unwanted. So to give the user control over what to do with
those revisions, <command>svndumpfilter</command> provides
- the following command-line options:</para>
+ the following command line options:</para>
<variablelist>
<varlistentry>
@@ -1255,7 +1255,7 @@
</variablelist>
<para>While <command>svndumpfilter</command> can be very
- useful, and a huge timesaver, there are unfortunately a
+ useful, and a huge time-saver, there are unfortunately a
couple of gotchas. First, this utility is overly sensitive
to path semantics. Pay attention to whether paths in your
dumpfile are specified with or without leading slashes.
@@ -1268,11 +1268,11 @@
…
</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
@@ -1280,8 +1280,8 @@
them—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
@@ -1431,7 +1431,7 @@
This subdirectory is a regular Berkeley DB environment
directory, and can therefore be used in conjunction with any
of Berkeley's database tools (you can see the documentation
- for these tools at SleepyCat's website, <systemitem
+ for these tools at Sleepycat's website, <systemitem
class="url">http://www.sleepycat.com/</systemitem>).</para>
<para>For day-to-day Subversion use, these tools are
@@ -1446,7 +1446,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
@@ -1528,10 +1528,10 @@
unversioned properties as a remote client is—the
<literal>pre-</literal> and
<literal>post-revprop-change</literal> hooks are still
- triggered, and therefore must be setup to accept changes of
+ triggered, and therefore must be set up 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>
<warning>
<para>Remember, though, that by bypassing the hooks, you are
@@ -1673,7 +1673,7 @@
past few years, disk usage is still a valid concern for
administrators seeking to version large amounts of data.
Every additional byte consumed by the live repository is a
- byte that needs to be backed up offsite, perhaps multiple
+ byte that needs to be backed up off-site, perhaps multiple
times as part of rotating backup schedules. Since the
primary storage mechanism of a Subversion repository is a
complex database system, it is useful to know what pieces of
@@ -2067,7 +2067,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>,
@@ -2373,7 +2373,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
like:</para>
<screen>
@@ -2455,7 +2455,7 @@
importing actual project data into your repository, if any
such data exists yet. Once again, there are several ways to
do this. You could use the <command>svn import</command>
- command. You could checkout a working copy from your new
+ command. You could check out a working copy from your new
repository, move and arrange project data inside the working
copy, and use the <command>svn add</command> and <command>svn
commit</command> commands. But once we start talking about
Index: doc/book/book/ch06.xml
===================================================================
--- doc/book/book/ch06.xml (revision 9632)
+++ doc/book/book/ch06.xml (working copy)
@@ -37,11 +37,11 @@
practice, there are only two servers at the time of
writing.</para>
- <para>Apache is an extremely popular webserver; using the
+ <para>Apache is an extremely popular web server; 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
+ <command>svnserve</command>: a small, stand-alone server
program that speaks a custom protocol with clients.</para>
<para>Note that Subversion, as an open-source project, does not
@@ -112,7 +112,7 @@
</row>
<row>
- <entry>Web Viewing</entry>
+ <entry>Web viewing</entry>
<entry>limited built-in support, or via 3rd-party tools
such as ViewCVS</entry>
@@ -177,7 +177,7 @@
to the server. Once authentication is complete, the server
responds with the original information the client asked for.
Notice that this system is different from systems like CVS,
- where the client pre-emptively offers credentials (<quote>logs
+ where the client preemptively offers credentials (<quote>logs
in</quote>) to the server before ever making a request. In
Subversion, the server <quote>pulls</quote> credentials by
challenging the client at the appropriate moment, rather than
@@ -211,7 +211,7 @@
<para>Happily, the Subversion client has a remedy for this: a
built-in system for caching authentication credentials on
- disk. By default, whenever the commandline client
+ disk. By default, whenever the command line client
successfully authenticates itself to a server, it saves the
credentials in the user's private runtime configuration
area—in <filename>~/.subversion/auth/</filename> on
@@ -345,7 +345,7 @@
<orderedlist>
<listitem>
<para>Check whether the user specified any credentials as
- commandline options, via <option>--username</option>
+ command line options, via <option>--username</option>
and/or <option>--password</option>. If not, or if these
options fail to authenticate successfully, then</para>
</listitem>
@@ -428,13 +428,13 @@
</screen>
<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>
<para>A second option is to run <command>svnserve</command> as a
- standalone <quote>daemon</quote> process. Use the
+ stand-alone <quote>daemon</quote> process. Use the
<option>-d</option> option for this:</para>
<screen>
@@ -470,7 +470,7 @@
<title>Servers and Permissions: A Word of Warning</title>
<para>First, remember that a Subversion repository is a
- collection of BerkeleyDB database files; any process which
+ collection of Berkeley DB database files; any process which
accesses the repository directly needs to have proper read
and write permissions on the entire repository. If you're
not careful, this can lead to a number of headaches. Be
@@ -719,15 +719,17 @@
<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 'harry'. The <command>svnserve</command>
+ 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 'harry', and if the client performs a commit,
+ 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>
@@ -817,12 +819,12 @@
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—specifically, versioned
writing—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>
@@ -865,7 +867,7 @@
been somewhat slow to upgrade to the Apache 2.X series for
various reasons: some people fear change, especially changing
something as critical as a web server. Other people depend on
- plug-in modules that only work against the Apache 1.3 API, and
+ plugin modules that only work against the Apache 1.3 API, and
are waiting for a 2.X port. Whatever the reason, many people
begin to worry when they first discover that Subversion's
Apache module is written specifically for the Apache 2 API.</para>
@@ -1020,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><Location
/www/repos></literal>. If a request comes in for the URI
<filename>/www/repos/foo.c</filename>, Apache won't know
@@ -1106,7 +1108,7 @@
<itemizedlist>
<listitem>
- <para>anyone can use their Subversion client to checkout a
+ <para>anyone can use their Subversion client to check out a
working copy of a repository URL (or any of its
subdirectories),</para>
</listitem>
@@ -1123,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>
@@ -1269,7 +1271,7 @@
<firstterm>certifying authority</firstterm> (CA). If
OpenSSL is unable to automatically trust the CA, or if some
other problem occurs (such as an expired certificate or
- hostname mismatch), the Subversion commandline client will
+ hostname mismatch), the Subversion command line client will
ask you whether you want to trust the server certificate
anyway:</para>
@@ -1343,7 +1345,7 @@
Subversion, it must be in PKCS#12 format, which is a
portable standard. Most web browsers are already able to
import and export certificates in that format. Another
- option is to use the OpenSSL commandline tools to convert
+ option is to use the OpenSSL command line tools to convert
existing certificates into PKCS#12.</para>
<para>Again, the runtime <filename>servers</filename> file
@@ -1391,7 +1393,7 @@
to your <literal><Location></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>
@@ -1594,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
@@ -1623,14 +1625,14 @@
sally = r
</screen>
- <para>In this first example, user harry has full read and
- write access on the
+ <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>
@@ -1640,7 +1642,7 @@
harry = rw
sally = r
-# give sally write access only to the 'testing' subdir
+# give sally write access only to the 'testing' subdirectory
[calc:/branches/calc/bug-142/testing]
sally = rw
</screen>
@@ -1685,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>
@@ -1712,8 +1714,8 @@
</screen>
<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 symbol</quote>
+ (<literal>@</literal>) prefix:</para>
<screen>
[calc:/projects/calc]
@@ -1949,14 +1951,14 @@
</screen>
<para>Another common problem is often encountered on Unix-like
- systems. As a repository is used, BerkeleyDB occasionally
+ systems. As a repository is used, Berkeley DB occasionally
creates new logfiles to journal its actions. Even if the
repository is wholly owned by the <command>svn</command> group,
these newly created files won't necessarily be owned by that
same group, which then creates more permissions problems for
your users. A good workaround is to set the group SUID bit on
the repository's <filename>db</filename> directory. This causes
- all newly-created logfiles to have the same group owner as the
+ all newly created logfiles to have the same group owner as the
parent directory.</para>
<para>Once you've jumped through these hoops, your repository
@@ -1984,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>
@@ -2007,7 +2009,7 @@
</listitem>
<listitem>
- <para>When BerkeleyDB creates new logfiles, they need to be
+ <para>When Berkeley DB creates new logfiles, they need to be
owned by the group as well, so make sure you run
<command>chmod g+s</command> on the repository's
<filename>db</filename> directory.</para>
Index: doc/book/book/ch07.xml
===================================================================
--- doc/book/book/ch07.xml (revision 9632)
+++ doc/book/book/ch07.xml (working copy)
@@ -7,7 +7,7 @@
start to finish, you should by now have acquired enough
knowledge to use the Subversion client to perform the most
common version control operations. You understand how to
- checkout a working copy from a Subversion repository. You are
+ check out a working copy from a Subversion repository. You are
comfortable with submitting and receiving changes using the
<command>svn commit</command> and <command>svn update</command>
functions. You've probably even developed a reflex which causes
@@ -52,7 +52,7 @@
<para>Subversion provides many optional behaviors that can be
controlled by the user. Many of these options are of the kind
that a user would wish to apply to all Subversion operations.
- So, rather than forcing users to remember command-line arguments
+ So, rather than forcing users to remember command line arguments
for specifying these options, and to use them for each and every
operation they perform, Subversion uses configuration files,
segregated into a Subversion configuration area.</para>
@@ -73,7 +73,7 @@
<title>Configuration Area Layout</title>
<para>The first time that the <command>svn</command>
- command-line client is executed, it creates a per-user
+ command line client is executed, it creates a per-user
configuration area. On Unix-like systems, this area appears
as a directory named <filename>.subversion</filename> in the
user's home directory. On Win32 systems, Subversion creates a
@@ -99,11 +99,11 @@
that the system-wide configuration area does not alone dictate
mandatory policy—the settings in the per-user
configuration area override those in the system-wide one, and
- command-line arguments supplied to the <command>svn</command>
+ command line arguments supplied to the <command>svn</command>
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
@@ -168,7 +168,7 @@
<orderedlist>
<listitem>
- <para>Command-line options</para>
+ <para>Command line options</para>
</listitem>
<listitem>
<para>The per-user INI files</para>
@@ -192,7 +192,7 @@
without deleting the entire key from the Registry, obviously
simplifying the process of restoring that option.</para>
- <para>The <command>svn</command> command-line client never
+ <para>The <command>svn</command> command line client never
attempts to write to the Windows Registry, and will not
attempt to create a default configuration area there. You can
create the keys you need using the <command>REGEDIT</command>
@@ -382,8 +382,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>
@@ -399,7 +400,7 @@
<varlistentry>
<term><literal>ssl-client-cert-file</literal></term>
<listitem>
- <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
@@ -450,7 +451,7 @@
credential caching. You can override this option for
a single instance of the <command>svn</command>
command using the <option>--no-auth-cache</option>
- command-line parameter (for those subcommands that
+ command line parameter (for those subcommands that
support it). For more information, see <xref
linkend="svn-ch-6-sect-2.2"/>.</para>
</listitem>
@@ -515,7 +516,7 @@
<para>This flag should be set to <literal>true</literal>
if the program specified by the
<literal>diff3-cmd</literal> option accepts a
- <option>--diff-program</option> command-line
+ <option>--diff-program</option> command line
parameter.</para>
</listitem>
</varlistentry>
@@ -555,7 +556,7 @@
<para>You can override this option for a single instance
of the <command>svn status</command> command by using
- the <option>--no-ignore</option> command-line flag.
+ the <option>--no-ignore</option> command line flag.
For information on more fine-grained control of
ignored items, see <xref linkend="svn-ch-7-sect-2.3.3"
/>.</para>
@@ -598,7 +599,7 @@
encoding for commit log messages. It's a permanent
form of the <option>--encoding</option> option (see
<xref linkend="svn-ch-9-sect-1.1"/>.) The Subversion
- repository stores log messages in UTF8, and assumes
+ repository stores log messages in UTF-8, and assumes
that your log message is written using your operating
system's native locale. You should specify a
different encoding if your commit messages are written
@@ -753,7 +754,7 @@
add or modify file and directory properties. For properties
with short, human-readable values, perhaps the simplest way to
add a new property is to specify the property name and value
- on the command-line of the <command>propset</command>
+ on the command line of the <command>propset</command>
subcommand.</para>
<screen>
@@ -765,7 +766,7 @@
<para>But we've been touting the flexibility that Subversion
offers for your property values. And if you are planning to
have a multi-line textual, or even binary, property value, you
- probably do not want to supply that value on the command-line.
+ probably do not want to supply that value on the command line.
So the <command>propset</command> subcommand takes a
<option>--file</option> (<option>-F</option>) option for
specifying the name of
@@ -902,7 +903,7 @@
<para>Remember those unversioned revision properties? You can
modify those, too, with the <command>svn</command> program.
- Simply add the <option>--revprop</option> command-line
+ Simply add the <option>--revprop</option> command line
parameter, and specify the revision whose property you wish
to modify. Since revisions are global, you don't need to
specify a path in this case as long as you are positioned in
@@ -927,8 +928,8 @@
administrator (see <xref linkend="svn-ch-5-sect-2.1" />).
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
+ The repository administrator can set up methods to protect
+ against this loss, and by default, modification of
unversioned properties is disabled.</para>
</sidebar>
@@ -938,7 +939,7 @@
repository with <command>svn commit</command>. Your property
changes can be easily unmade, too—the <command>svn
revert</command> command will restore your files and
- directories to their un-edited states, contents, properties,
+ directories to their unedited states, contents, properties,
and all. Also, you can receive interesting information about
the state of your file and directory properties by using the
<command>svn status</command> and <command>svn diff</command>
@@ -1245,8 +1246,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
@@ -1379,7 +1380,7 @@
change this file in the repository, and looks
something like <literal>$LastChangedBy: harry
$</literal>. It may be abbreviated as
- <literal>Author</literal></para>
+ <literal>Author</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -1658,7 +1659,7 @@
made out of a number of different checkouts. For example, you
may want different subdirectories to come from different
locations in a repository, or perhaps from different
- repositories altogether. You could certainly setup such a
+ repositories altogether. You could certainly set up such a
scenario by hand—using <command>svn checkout</command> to
create the sort of nested working copy structure you are trying
to achieve. But if this layout is important for everyone who
@@ -1690,12 +1691,12 @@
once one person has made the effort to define those nested
working copy checkouts, no one else has to
bother—Subversion will, upon checkout of the original
- working copy, also checkout the external working copies.</para>
+ working copy, also check out the external working copies.</para>
<para>Note the previous externals definition example. When
someone checks out a working copy of the
<filename>calc</filename> directory, Subversion also continues
- to checkout the items found in its externals definition.</para>
+ to check out the items found in its externals definition.</para>
<screen>
$ svn checkout http://svn.example.com/repos/calc
@@ -1749,7 +1750,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—even
- frustrating—in certain situtations. For example, if you
+ frustrating—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
@@ -1910,7 +1911,7 @@
libcomplex 1.1, and then re-apply the custom modifications we
previously made to that library to the new version.</para>
- <para>To perform this upgrade, we checkout a copy of our vendor
+ <para>To perform this upgrade, we check out a copy of our vendor
branch, and replace the <literal>current</literal> version
with the new libcomplex 1.1 source code. After committing
this change, our <literal>current</literal> branch now
@@ -2018,7 +2019,7 @@
<para>You can indicate that you'd like
<command>svn_load_dirs.pl</command> to tag the new vendor drop
- by passing the <option>-t</option> command-line option and
+ by passing the <option>-t</option> command line option and
specifying a tag name. This tag is another URL relative to
the first program argument.</para>
@@ -2050,7 +2051,7 @@
expression that are <emphasis>added</emphasis> to the
repository. This configuration file is specified to
<command>svn_load_dirs.pl</command> using the
- <option>-p</option> command-line option. Each line of the
+ <option>-p</option> command line option. Each line of the
configuration file is a whitespace-delimited set of two or
four values: a Perl-style regular expression to match the
added path against, a control keyword (either
Index: doc/book/book/ch08.xml
===================================================================
--- doc/book/book/ch08.xml (revision 9632)
+++ doc/book/book/ch08.xml (working copy)
@@ -127,10 +127,10 @@
<para>The client itself also highlights modularity in the
Subversion design. While Subversion currently comes with only a
- command-line client program, there are already a few other
+ command line client program, there are already a few other
programs being developed by third parties to act as GUIs for
Subversion. Again, these GUIs use the same APIs that the stock
- command-line client does. Subversion's libsvn_client library is
+ command line client does. Subversion's libsvn_client library is
the one-stop shop for most of the functionality necessary for
designing a working Subversion client (see <xref
linkend="svn-ch-8-sect-1.3"/>).</para>
@@ -293,7 +293,7 @@
added dimension to the Subversion filesystem universe.</para>
<figure id="svn-ch8-sect1.1-dia2">
- <title>Revisioning Time—the Third Dimension!</title>
+ <title>Versioning Time—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
@@ -509,7 +509,7 @@
<quote>speak</quote> so that the RA loader can, at runtime,
determine which module to use for the task at hand. You can
determine which RA modules are available to the Subversion
- command-line client, and what protocols they claim to support,
+ command line client, and what protocols they claim to support,
by running <command>svn --version</command>:</para>
<screen>
@@ -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
@@ -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
@@ -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
@@ -754,22 +754,22 @@
<para>The client library is designed to be used by any
application. While the Subversion source code includes a
- standard command-line client, it should be very easy to write
+ standard command line client, it should be very easy to write
any number of GUI clients on top of the client library. New
GUIs (or any new client, really) for Subversion need not be
- clunky wrappers around the included command-line
+ clunky wrappers around the included command line
client—they have full access via the libsvn_client API
to same functionality, data, and callback mechanisms that the
- command-line client uses.</para>
+ command line client uses.</para>
<sidebar>
<title>Binding Directly—A Word About Correctness</title>
<para>Why should your GUI program bind directly with a
libsvn_client instead of acting as a wrapper around a
- command-line program? Besides simply being more efficient,
+ command line program? Besides simply being more efficient,
this can address potential correctness issues as well. A
- command-line program (like the one supplied with Subversion)
+ command line program (like the one supplied with Subversion)
that binds to the client library needs to effectively
translate feedback and requested data bits from C types to
some form of human-readable output. This type of
@@ -777,7 +777,7 @@
display all of the information harvested from the API, or
may combine bits of information for compact representation.</para>
- <para>If you wrap such a command-line program with yet another
+ <para>If you wrap such a command line program with yet another
program, the second program has access only to
already-interpreted (and as we mentioned, likely incomplete)
information, which it must <emphasis>again</emphasis>
@@ -854,7 +854,7 @@
</footnote>
APR gives Subversion immediate access to many custom
datatypes, such as dynamic arrays and hash tables. Subversion
- uses these types extensively throughout the codebase. But
+ uses these types extensively throughout the code base. But
perhaps the most pervasive APR datatype, found in nearly every
Subversion API prototype, is the apr_pool_t—the APR
memory pool. Subversion uses pools internally for all its
@@ -1079,7 +1079,7 @@
to those files and directories.</para>
</listitem>
<listitem>
- <para>Pristine (un-edited) copies of the working copy
+ <para>Pristine (unedited) copies of the working copy
files.</para>
</listitem>
</itemizedlist>
@@ -1546,7 +1546,7 @@
the source tree for instructions.</para>
<para>After you have a working Subversion client, you are now
- poised to checkout a working copy of the Subversion source
+ poised to check out a working copy of the Subversion source
repository from <systemitem
class="url">http://svn.collab.net/repos/svn/trunk/</systemitem>:
<footnote>
@@ -1567,7 +1567,7 @@
…
</screen>
- <para>The above command will checkout the bleeding-edge, latest
+ <para>The above command will check out the bleeding-edge, latest
version of the Subversion source code into a subdirectory
named <filename>subversion</filename> in your current working
directory. Obviously, you can adjust that last argument as
@@ -1591,7 +1591,7 @@
<filename>HACKING</filename> file contains general
instructions for contributing to Subversion, including how to
properly format your source code for consistency with the rest
- of the codebase, how to describe your proposed changes with an
+ of the code base, how to describe your proposed changes with an
effective change log message, how to test your changes, and so
on. Commit privileges on the Subversion source repository are
earned—a government by meritocracy.
@@ -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 9632)
+++ doc/book/book/ch09.xml (working copy)
@@ -53,7 +53,7 @@
<varlistentry>
<term><option>--auto-props</option></term>
<listitem>
- <para>Enable auto-props, overriding the
+ <para>Enables auto-props, overriding the
<literal>enable-auto-props</literal> directive in the
<filename>config</filename> file.</para>
</listitem>
@@ -197,8 +197,8 @@
<varlistentry>
<term><option>--ignore-ancestry</option></term>
<listitem>
- <para>Ignore ancestry when calculating differences (rely
- on path contents alone).</para>
+ <para>Tells Subversion to ignore ancestry when calculating
+ differences (rely on path contents alone).</para>
</listitem>
</varlistentry>
@@ -244,7 +244,7 @@
<varlistentry>
<term><option>--no-auto-props</option></term>
<listitem>
- <para>Disable auto-props, overriding the
+ <para>Disables auto-props, overriding the
<literal>enable-auto-props</literal> directive in the
<filename>config</filename> file.</para>
</listitem>
@@ -484,7 +484,7 @@
<refentry>
<refnamediv>
<refname>svn add</refname>
- <refpurpose>Adds files and directories</refpurpose>
+ <refpurpose>Add files and directories.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -493,8 +493,8 @@
<refsect1>
<title>Description</title>
- <para>Adds files and directories to your working copy and
- schedules them for addition to the repository. They
+ <para>Add files and directories to your working copy and
+ schedule them for addition to the repository. They
will be uploaded and added to the repository on your
next commit. If you add something and change your mind
before committing, you can unschedule the addition using
@@ -560,7 +560,7 @@
<refentry>
<refnamediv>
<refname>svn blame</refname>
- <refpurpose>Shows author and revision information in-line
+ <refpurpose>Show author and revision information in-line
for the specified files or URLs.</refpurpose>
</refnamediv>
<refsect1>
@@ -570,7 +570,7 @@
<refsect1>
<title>Description</title>
- <para>Shows author and revision information in-line for the
+ <para>Show author and revision information in-line for the
specified files or URLs. Each line of text is annotated
at the beginning with the author (username) and the
revision number for the last change to that line.</para>
@@ -622,7 +622,7 @@
<refentry>
<refnamediv>
<refname>svn cat</refname>
- <refpurpose>Outputs the contents of the specified files or
+ <refpurpose>Output the contents of the specified files or
URLs.</refpurpose>
</refnamediv>
<refsect1>
@@ -632,7 +632,7 @@
<refsect1>
<title>Description</title>
- <para>Outputs the contents of the specified files or URLs.
+ <para>Output the contents of the specified files or URLs.
For listing the contents of directories, see <command>svn
list</command>.</para>
</refsect1>
@@ -677,7 +677,7 @@
</screen>
<tip>
- <para>If your working copy is out of date (or you have
+ <para>If your working copy is out-of-date (or you have
local modifications) and you want to see the
<literal>HEAD</literal> revision of a file in your working
copy, <command>svn cat</command> will automatically fetch
@@ -701,7 +701,7 @@
<refentry>
<refnamediv>
<refname>svn checkout</refname>
- <refpurpose>Checks out a working copy from a repository.</refpurpose>
+ <refpurpose>Check out a working copy from a repository.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -710,12 +710,12 @@
<refsect1>
<title>Description</title>
- <para>Checks out a working copy from a repository. If
+ <para>Check out a working copy from a repository. If
<replaceable>PATH</replaceable> is omitted, the
basename of the URL will be used as the
destination. If multiple URLs are given each will be
- checked out into a sub-directory of PATH, with the
- name of the sub-directory being the basename of the
+ checked out into a subdirectory of PATH, with the
+ name of the subdirectory being the basename of the
URL.</para>
</refsect1>
@@ -841,7 +841,7 @@
<title>Description</title>
<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
@@ -1551,7 +1551,7 @@
<refentry>
<refnamediv>
<refname>svn export</refname>
- <refpurpose>Exports a clean directory tree.</refpurpose>
+ <refpurpose>Export a clean directory tree.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -1941,7 +1941,7 @@
…
</screen>
- <para>Like UNIX <command>ls</command>, you can also pass
+ <para>Like Unix <command>ls</command>, you can also pass
the <option>--verbose</option> switch for additional
information:</para>
@@ -1961,8 +1961,8 @@
<!-- ================================================================= -->
<refentry>
<refnamediv>
- <refname>svn log</refname> <refpurpose>Displays commit log
- messages.</refpurpose>
+ <refname>svn log</refname>
+ <refpurpose>Display commit log messages.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -2152,7 +2152,8 @@
</screen>
<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>
<screen>
@@ -2179,7 +2180,7 @@
<tip>
<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>
<screen>
$ svn log -r 20 http://svn.red-bean.com/untouched.txt
@@ -2522,7 +2523,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>
@@ -2561,7 +2562,7 @@
<title>Examples</title>
<para>Delete a property from a file in your working
- copy</para>
+ copy:</para>
<screen>
$ svn propdel svn:mime-type some-script
@@ -2593,7 +2594,7 @@
<refsect1>
<title>Description</title>
- <para>Edits one or more properties using your favorite
+ <para>Edit one or more properties using your favorite
editor. The first form edits versioned properties in
your working copy, while the second edits unversioned
remote properties on a repository revision.</para>
@@ -2652,7 +2653,7 @@
<refentry>
<refnamediv>
<refname>svn propget</refname>
- <refpurpose>Prints the value of a property.</refpurpose>
+ <refpurpose>Print the value of a property.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -2662,7 +2663,7 @@
<refsect1>
<title>Description</title>
- <para>Prints the value of a property on files,
+ <para>Print the value of a property on files,
directories, or revisions. The first form prints the
versioned property of an item or items in your working
copy, while the second prints unversioned remote
@@ -2729,7 +2730,7 @@
<refentry>
<refnamediv>
<refname>svn proplist</refname>
- <refpurpose>Lists all properties.</refpurpose>
+ <refpurpose>List all properties.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -2739,9 +2740,9 @@
<refsect1>
<title>Description</title>
- <para>Lists all properties on files, directories, or
+ <para>List 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>
@@ -2874,14 +2875,14 @@
<refsect1>
<title>Examples</title>
- <para>Set the mimetype on a file:</para>
+ <para>Set the mime-type on a file:</para>
<screen>
$ svn propset svn:mime-type image/jpeg foo.jpg
property 'svn:mime-type' set on 'foo.jpg'
</screen>
- <para>On a UNIX system, if you want a file to have the
+ <para>On a Unix system, if you want a file to have the
executable permission set:</para>
<screen>
@@ -2890,7 +2891,7 @@
</screen>
<para>Perhaps you have an internal policy to set certain
- properties for the benefit of your coworkers:</para>
+ properties for the benefit of your co-workers:</para>
<screen>
$ svn propset owner sally foo.c
@@ -3133,7 +3134,7 @@
<title>Description</title>
<para>Print the status of working copy files and
- directories. With no arguments, it prints only locally
+ directories. With no arguments, print only locally
modified items (no repository access). With
<option>--show-updates</option>, add working revision
and server out-of-date information. With
@@ -3190,7 +3191,7 @@
<term>'I'</term>
<listitem>
<para>Item is being ignored (e.g. with the
- svn:ignore property)</para>
+ svn:ignore property).</para>
</listitem>
</varlistentry>
@@ -3215,7 +3216,7 @@
<term>'~'</term>
<listitem>
<para>Item is versioned as a directory, but has
- been replaced by a file, or vice versa</para>
+ been replaced by a file, or vice versa.</para>
</listitem>
</varlistentry>
@@ -3303,7 +3304,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>
@@ -3417,7 +3418,7 @@
<note>
<para><option>--show-updates</option>
<emphasis>only</emphasis> places an asterisk next to items
- that are out of date (that is, items that will be updated
+ that are out-of-date (that is, items that will be updated
from the repository if you run <command>svn
update</command>). <option>--show-updates</option> does
<emphasis>not</emphasis> cause the status listing to
@@ -3563,7 +3564,7 @@
<refentry>
<refnamediv>
<refname>svn update</refname>
- <refpurpose>Updates your working copy.</refpurpose>
+ <refpurpose>Update your working copy.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -3573,7 +3574,7 @@
<title>Description</title>
<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 @@
<varlistentry>
<term><option>--force-uuid</option></term>
<listitem>
- <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
@@ -3820,8 +3821,7 @@
<refentry>
<refnamediv>
<refname>svnadmin create</refname>
- <refpurpose>Create a new, empty repository at
- <replaceable>REPOS_PATH</replaceable>.</refpurpose>
+ <refpurpose>Create a new, empty repository.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -3954,7 +3954,7 @@
<refentry>
<refnamediv>
<refname>svnadmin hotcopy</refname>
- <refpurpose>Makes a hot copy of a repository.</refpurpose>
+ <refpurpose>Make a hot copy of a repository.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -4148,7 +4148,7 @@
<refentry>
<refnamediv>
<refname>svnadmin recover</refname>
- <refpurpose>Recovers any lost state in a repository.</refpurpose>
+ <refpurpose>Recover any lost state in a repository.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -4182,7 +4182,7 @@
<refentry>
<refnamediv>
<refname>svnadmin rmtxns</refname>
- <refpurpose>Deletes transactions from a repository.</refpurpose>
+ <refpurpose>Delete transactions from a repository.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -4191,7 +4191,7 @@
<refsect1>
<title>Description</title>
- <para>Deletes outstanding transactions from a repository.
+ <para>Delete outstanding transactions from a repository.
This is covered in detail in <xref
linkend="svn-ch-5-sect-3.2"/>.</para>
</refsect1>
@@ -4231,7 +4231,7 @@
<refentry>
<refnamediv>
<refname>svnadmin setlog</refname>
- <refpurpose>Set the log-message on a revision.</refpurpose>
+ <refpurpose>Set the log message on a revision.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -4240,7 +4240,7 @@
<refsect1>
<title>Description</title>
- <para>Set the log-message on revision REVISION to the
+ <para>Set the log message on revision REVISION to the
contents of FILE.</para>
<para>This is similar to using <command>svn propset
@@ -4285,7 +4285,7 @@
<refentry>
<refnamediv>
<refname>svnadmin verify</refname>
- <refpurpose>Verifies the data stored in the repository.</refpurpose>
+ <refpurpose>Verify the data stored in the repository.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -4323,7 +4323,7 @@
<sect1 id="svn-ch-9-sect-3">
<title><command>svnlook</command></title>
- <para><command>svnlook</command> is a command-line utility for
+ <para><command>svnlook</command> is a command line utility for
examining different aspects of a Subversion repository. It
does not make any changes to the repository—it's just
used for <quote>peeking</quote>.
@@ -4344,7 +4344,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>
@@ -4375,7 +4375,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>
@@ -4399,7 +4399,7 @@
<refentry>
<refnamediv>
<refname>svnlook author</refname>
- <refpurpose>Prints the author.</refpurpose>
+ <refpurpose>Print the author.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -4408,7 +4408,7 @@
<refsect1>
<title>Description</title>
- <para>Prints the author of a revision or transaction in
+ <para>Print the author of a revision or transaction in
the repository.</para>
</refsect1>
@@ -4579,7 +4579,7 @@
<refentry>
<refnamediv>
<refname>svnlook diff</refname>
- <refpurpose>Prints differences of changed files and properties.</refpurpose>
+ <refpurpose>Print differences of changed files and properties.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -4588,7 +4588,7 @@
<refsect1>
<title>Description</title>
- <para>Prints GNU-style differences of changed files and
+ <para>Print GNU-style differences of changed files and
properties in a repository.</para>
</refsect1>
@@ -4877,8 +4877,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>
@@ -4952,7 +4952,7 @@
<refentry>
<refnamediv>
<refname>svnlook tree</refname>
- <refpurpose>Print the tree</refpurpose>
+ <refpurpose>Print the tree.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
@@ -4963,7 +4963,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
Ninety percent of the politicians give the other ten percent a bad reputation.
-- Henry Kissinger
Received on Thu May 6 10:52:12 2004