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

PATCH: book: miscellaneous minor fixes

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2003-06-26 00:06:54 CEST

Minor fixes to documentation.

* doc/book/book/ch01.xml
* doc/book/book/ch05.xml
  Fix grammar.

* doc/book/book/ch08.xml
  Fix grammar of a reference to a syntax specification.
  Change a note (that explains that no log output means no change) from type
  "warning" to type "tip" because it is not a dangerous situation.

* doc/README
  Update our rules for quoting, because we want to use <quote> which is not the
  standard practice in texinfo.

Index: doc/book/book/ch01.xml
===================================================================
--- doc/book/book/ch01.xml (revision 6346)
+++ doc/book/book/ch01.xml (working copy)
@@ -216,7 +216,7 @@
       website (<systemitem
       class="url">http://subversion.tigris.org</systemitem>) often has
       binaries available for download, posted by volunteers. The site
- usually contains graphical installer packages for users for
+ usually contains graphical installer packages for users of
       Microsoft operating systems. If you run a Unix-like operating
       system, you can use your system's native package-distribution
       system (rpm, deb, ports tree) to get Subversion.</para>
@@ -224,8 +224,8 @@
     <para>Alternately, you can build Subversion directly from source
       code. From the website, you can download the latest source-code
       release. After unpacking it, follow the instructions in INSTALL
- to build it. Note that released source package contains
- everything you need to build a commandline-client capable of
+ to build it. Note that a released source package contains
+ everything you need to build a command-line client capable of
       talking to a remote repository (in particular, the apr,
       apr-util, and neon libraries.) But Subversion has many other
       dependencies, such as Berkeley DB and possibly Apache httpd.
Index: doc/book/book/ch05.xml
===================================================================
--- doc/book/book/ch05.xml (revision 6346)
+++ doc/book/book/ch05.xml (working copy)
@@ -77,7 +77,7 @@
         completes, the temporary transaction is deleted.</para>
           
       <para>The use of transaction trees is the only way to make
- permanent changes to repository's versioned filesystem.
+ permanent changes to a repository's versioned filesystem.
         However, it's important to understand that the lifetime of a
         transaction is completely flexible. In the case of updates,
         transactions are temporary trees that are immediately
Index: doc/book/book/ch08.xml
===================================================================
--- doc/book/book/ch08.xml (revision 6346)
+++ doc/book/book/ch08.xml (working copy)
@@ -1699,7 +1699,7 @@
             </screen>
 
             <para>If you want several distinct paths underneath the
- same URL, you can use the <literal>[URL PATH
+ same URL, you can use the <literal>URL [PATH [PATH
               ...]]</literal> syntax.</para>
 
             <screen>
@@ -1793,7 +1793,7 @@
 
 
 
- <warning>
+ <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>
@@ -1816,7 +1816,7 @@
 Made a change.
 ------------------------------------------------------------------------
               </screen>
- </warning>
+ </tip>
 
           </refsect1>
         </refentry>
Index: doc/README
===================================================================
--- doc/README (revision 6346)
+++ doc/README (working copy)
@@ -59,8 +59,9 @@
 
 http://www.gnu.org/manual/texinfo-4.0/html_chapter/texinfo_toc.html
 
-1) Use `` and '' for quoting any text. Do not use a single ' or a
- single ".
+1) Use <quote>...</quote> for quoting any text in the Subversion book.
+ [Do not use the standard Texinfo practice which is `` and ''.
+ Do not use a single ' or a single ".]
 2) When quoting single characters, such as discussing the output from
    an svn merge or svn update, use @samp{}.
 3) Use @samp{} for any commands to run on the command line. Do not use

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu Jun 26 00:00:18 2003

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.