Re: Updates to ch01.xml

A reasonable thing to be doing; some comments on the details follow...

Unfortunately it appears that your mail program has wrapped some of the lines in these patches, which makes them invalid (the "patch" program can no longer understand them). Please could you either set your mail program to not wrap (or wrap at say column 90 instead of 78 or whatever) or send the patch files as attachments rather than in line in the message body.

Also, it helps a bit if you can supply a brief log message in the format described in the file "HACKING" (in the root of the source directory tree). It just needs to summarize the types of change, like you did in this email message, and would look like this for ch01.xml:

* doc/book/book/ch01.xml
  Changed lower-case "subversion" to "Subversion" and "ssh" to "SSH".
  Minor edits for readability, etc.

In this case it was

Matt Blais wrote:
> Changed lower-case "subversion" to "Subversion"

Good.

> and "ssh" to "SSH";

OK. But be careful not to do that in places (in other chapters) where it is the name of the program (executable file) "ssh" or the URL schema "svn+ssh:". And you missed one.

> Minor edits for readability, etc.

I agree with these, but don't put too much effort into these because sections are still being re-written now and again. (And others still need to be written.)

Also...

> D:\Collabnet\svn\trunk\doc\book\book>svn diff ch01.xml
> Index: ch01.xml
> ===================================================================
> --- ch01.xml (revision 6740)
> +++ ch01.xml (working copy)
...
> @@ -152,7 +152,7 @@
> interoperability, and provides various key features for
> free: authentication, authorization, wire compression, and
> repository browsing, for example. A smaller, standalone
> - svn server process is also available. This server speaks
> + Subversion server process is also available. This server
> + speaks

Bad indentation here and in other places in this and your other patches.

> a custom protocol which can be easily tunneled over ssh.

You didn't change "ssh" here.

> @@ -222,7 +222,7 @@
> system, you can use your system's native package-distribution
> system (rpm, deb, ports tree) to get Subversion.</para>
>
> - <para>Alternately, you can build Subversion directly from source
> + <para>Alternately, you can build Subversion directly from the
> + source
> code. From the website, you can download the latest source-code
> release. After unpacking it, follow the instructions in the
> INSTALL

That "INSTALL" at the beginning of a line is a mailer wrapping problem.

Also, the first couple of things I have noticed in your "ch03.xml" patch:

Matt Blais wrote:
> Index: ch03.xml
> ===================================================================
> --- ch03.xml (revision 6740)
> +++ ch03.xml (working copy)
> @@ -3,14 +3,14 @@
>
> <simplesect>
>
> - <para>Now we will go into the details of using Subversion. By the
> - time you reach the end of this chapter, you will be able to
> - perform almost all the tasks you need to use Subversion in a
> - normal day's work. You'll start with an initial checkout of
> + <para>Now we will go into the details of using Subversion. By the

Here you seem to have added a space in the middle of the line ... presumably not on purpose?

> @@ -32,7 +32,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 tries to be
> - self-documenting&mdash;at any time, a quick <command>svn help
> + self-documenting&mdash; a quick <command>svn help

M-dashes don't have a space before or after them in the format of this book.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sat Aug 16 00:09:06 2003