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

[PATCH] Book: fix minor sentence structure inconsistencies

From: Michael W Thelen <thelenm_at_cs.utah.edu>
Date: 2004-05-21 08:49:28 CEST

Okay, last one. This patch fixes minor sentence structure
inconsistencies in the book, mostly in subcommand and option listings.

Thanks for your patience with these patches. There's still the issue of
conforming to the O'Reilly style guide ("UNIX" versus "Unix" and all
that). I have worked about halfway through that so far, and will post
one more book patch when it's done.

-- Mike

Log:
Fix minor sentence structure inconsistencies in the book.

* doc/book/book/ch05.xml
  (svn-ch-5-sect-3.1.2): Change several sentences that begin with third-person
  singular verbs (e.g. "Creates a repository") so they start with the verb in
  the imperative form (e.g. "Create a repository"). This is for consistency
  across all the svnadmin subcommand listings.

* doc/book/book/ch06.xml
  (svn-ch-6-table-1): Uncapitalize "viewing" in "Web viewing", for consistency
  with the other items in the table.

* doc/book/book/ch07.xml
  (svn-ch-7-sect-2.3.4): Add a period at the end of the LastChangedBy
  description, for consistency with the other keyword descriptions.

* doc/book/book/ch09.xml:
  (svn-ch-9-sect-1.1): Change imperative verbs to third-person singular form,
  for consistency across all the svn switches.
  (svn-ch-9-sect-1.2): Change third-person singular verbs to imperative form,
  for consistency across all the svn subcommand listings. Also fix missing
  periods at the ends of sentences.

Index: doc/book/book/ch05.xml
===================================================================
--- doc/book/book/ch05.xml (revision 9813)
+++ doc/book/book/ch05.xml (working copy)
@@ -929,7 +929,7 @@
           <varlistentry>
             <term><literal>create</literal></term>
             <listitem>
- <para>Creates a new Subversion repository.</para>
+ <para>Create a new Subversion repository.</para>
             </listitem>
           </varlistentry>
 
@@ -947,7 +947,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>
@@ -955,7 +955,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>
@@ -965,7 +965,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&mdash;those still in use by Subversion, as
                 well as those no longer in use.</para>
@@ -975,7 +975,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
@@ -987,7 +987,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>
Index: doc/book/book/ch06.xml
===================================================================
--- doc/book/book/ch06.xml (revision 9813)
+++ doc/book/book/ch06.xml (working copy)
@@ -113,7 +113,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>
Index: doc/book/book/ch07.xml
===================================================================
--- doc/book/book/ch07.xml (revision 9813)
+++ doc/book/book/ch07.xml (working copy)
@@ -1360,7 +1360,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>
Index: doc/book/book/ch09.xml
===================================================================
--- doc/book/book/ch09.xml (revision 9813)
+++ 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>
@@ -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>
@@ -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>
@@ -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>
@@ -2593,7 +2593,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 +2652,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 +2662,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 +2729,7 @@
       <refentry>
         <refnamediv>
           <refname>svn proplist</refname>
- <refpurpose>Lists all properties.</refpurpose>
+ <refpurpose>List all properties.</refpurpose>
         </refnamediv>
         <refsect1>
           <title>Synopsis</title>
@@ -2739,7 +2739,7 @@
         <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
             properties on a repository revision.</para>
@@ -3190,7 +3190,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 +3215,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>
 
@@ -3563,7 +3563,7 @@
       <refentry>
         <refnamediv>
           <refname>svn update</refname>
- <refpurpose>Updates your working copy.</refpurpose>
+ <refpurpose>Update your working copy.</refpurpose>
         </refnamediv>
         <refsect1>
           <title>Synopsis</title>
@@ -3820,8 +3820,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>
@@ -3989,7 +3988,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>
@@ -4183,7 +4182,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>
@@ -4217,7 +4216,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>
@@ -4226,7 +4225,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>
@@ -4320,7 +4319,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>
@@ -4434,7 +4433,7 @@
       <refentry>
         <refnamediv>
           <refname>svnlook author</refname>
- <refpurpose>Prints the author.</refpurpose>
+ <refpurpose>Print the author.</refpurpose>
         </refnamediv>
         <refsect1>
           <title>Synopsis</title>
@@ -4443,7 +4442,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>
 
@@ -4614,7 +4613,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>
@@ -4623,7 +4622,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>
 
@@ -4987,7 +4986,7 @@
       <refentry>
         <refnamediv>
           <refname>svnlook tree</refname>
- <refpurpose>Print the tree</refpurpose>
+ <refpurpose>Print the tree.</refpurpose>
         </refnamediv>
         <refsect1>
           <title>Synopsis</title>

-- 
Michael W. Thelen
Continued dependence upon relief induces a spiritual and moral disintegration
fundamentally destructive to the national fibre. To dole out relief in this
way is to administer a narcotic, a subtle destroyer of the human spirit.
                -- Franklin Delano Roosevelt

Received on Fri May 21 08:51:16 2004

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