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

Re: [PATCH] documentation fixes

From: B. W. Fitzpatrick <fitz_at_red-bean.com>
Date: 2003-02-23 07:45:51 CET

Ben Elliston <bje@air.net.au> writes:

> Attached is a changeset that makes some documentation changes that I noted
> while reading "Subversion: The Definitive Guide". I tried to minimise any
> stylistic changes in light of the statements made in the doc/book/HACKING
> file, since they're less likely to be accepted. :-) My log message is
> quite verbose; I hope that it provides sufficient justification for the
> changes.
>
> In most cases, I was looking to clarify things or make the text read more
> smoothly. I'd like to specifically defend the change to ch08.xml -- while
> I appreciate that hacker lingo makes for a more enjoyable document, I fear
> it will confuse readers whose mother tongue is not English. In such
> cases, writers should probably take the conservative line.
>
> Keep up the great work. Subversion rocks!
>
> Ben
>
> * doc/book/book/ch01.xml
> (Target audience): Remove duplicated use of "appendix".
> (History): Use commas instead of parentheses where applicable.
> Reword some sentences to flow better.
> (History of Subversion): Surround Collabnet URL in parentheses.
> * doc/book/book/ch02.xml
> (The Repository): Mention that .svn directories have the nice
> property of not showing up in normal directory listings.
> (How working copies track the repository): Reword. Remove commas
> from the terms in the list of possible file states.
> * doc/book/book/ch03.xml
> (Make Changes to Your Working Copy): Reword some paragraphs.
> (Changing the Repository Without a Working Copy): Remove excess
> parentheses.
> (Examine Your Changes): Add commentary about reviewing patches.
> (CVS Users: Hold That Update!): Add comment about "cvs update".
> (Look Ma! No Network!): Beach hacking is more realistic for most
> of us than being on the flight deck of the Space Shuttle.
> Replace occurrence of "1" with "one".
> (Resolving conflicts): Remove surplus comma.
> * doc/book/book/ch08.xml
> (svn export): Replace "rolling" with "producing".

Ben, I have applied the chapter 03 patch (with only one change--
s/aeroplane/airplace/) in revision 5032.

The chapter 08 patch was rendered unnecessary from my rewrite.

I'm still leaving chapter 01 and 02 to Ben, who authored those
chapters. Hey Ben, get on those patches!a

Sorry for the massive delay--your patch was *excellent*!

Thanks again,

-Fitz

--
Brian W. Fitzpatrick    <fitz_at_red-bean.com>   http://www.red-bean.com/fitz/
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sun Feb 23 07:47:15 2003

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