[svnbook commit] r2713 - trunk/src/en/book

sussman noreply at red-bean.com
Mon Feb 26 21:47:28 CST 2007


Author: sussman
Date: Mon Feb 26 21:47:28 2007
New Revision: 2713

Modified:
   trunk/src/en/book/ch02-basic-usage.xml
   trunk/src/en/book/ch03-advanced-topics.xml
   trunk/src/en/book/ch04-branching-and-merging.xml
   trunk/src/en/book/ch06-server-configuration.xml

Log:

* src/en/book/ch02-basic-usage.xml,
* src/en/book/ch03-advanced-topics.xml,
* src/en/book/ch04-branching-and-merging.xml,
* src/en/book/ch06-server-configuration.xml:

       Try to consistify our use of long and short options, based on
       new HACKING rules.



Modified: trunk/src/en/book/ch02-basic-usage.xml
==============================================================================
--- trunk/src/en/book/ch02-basic-usage.xml	(original)
+++ trunk/src/en/book/ch02-basic-usage.xml	Mon Feb 26 21:47:28 2007
@@ -316,7 +316,7 @@
         sometimes that's not helpful—particularly if you're
         working in a shared working copy, like a system configuration
         directory or a webserver document root.  In this case, just
-        pass the <option>--username option</option > on the
+        pass the <option>--username</option> option on the
         commandline and Subversion will attempt to authenticate as
         that user, prompting you for a password if necessary.</para>
 
@@ -513,8 +513,7 @@
               underneath <filename>foo</filename> will be scheduled
               for addition.  If you only want to add
               <filename>foo</filename> itself, pass the
-              <option>--non-recursive</option> (<option>-N</option>)
-              switch.</para>
+              <option>--non-recursive (-N)</option> option.</para>
 
           </listitem>
         </varlistentry>
@@ -763,10 +762,9 @@
 </screen>
 
         <para><command>svn status</command> also has a
-          <option>--verbose</option> (<option>-v</option>) switch,
-          which will show you the status of <emphasis>every</emphasis>
-          item in your working copy, even if it has not been
-          changed:</para>
+          <option>--verbose (-v)</option> switch, which will show you
+          the status of <emphasis>every</emphasis> item in your
+          working copy, even if it has not been changed:</para>
 
         <screen>
 $ svn status -v
@@ -793,10 +791,9 @@
           status</command> contact the repository, they work only
           locally by comparing the metadata in the
           <filename>.svn</filename> directory with the working copy.
-          Finally, there is the <option>--show-updates</option>
-          (<option>-u</option>) switch, which contacts the repository
-          and adds information about things that are
-          out-of-date:</para>
+          Finally, there is the <option>--show-updates (-u)</option>
+          option, which contacts the repository and adds information
+          about things that are out-of-date:</para>
 
         <screen>
 $ svn status -u -v
@@ -905,7 +902,7 @@
           unified diff format, by default.  If you want diff output in
           a different format, specify an external diff program using
           <option>--diff-cmd</option> and pass any flags you'd like to
-          it using the <option>--extensions</option> switch.  For
+          it using the <option>--extensions (-x)</option> switch.  For
           example, to see local differences in file
           <filename>foo.c</filename> in context output format while
           ignoring case differences, you might run <command>svn diff
@@ -1118,7 +1115,7 @@
         until the three temporary files are removed.</para>
 
       <screen>
-$ svn commit --message "Add a few more things"
+$ svn commit -m "Add a few more things"
 svn: Commit failed (details follow):
 svn: Aborting commit: '/home/sally/svn-work/sandwich.txt' remains in conflict
 </screen>
@@ -1331,7 +1328,7 @@
         switch:</para>
 
       <screen>
-$ svn commit --message "Corrected number of cheese slices."
+$ svn commit -m "Corrected number of cheese slices."
 Sending        sandwich.txt
 Transmitting file data .
 Committed revision 3.
@@ -1340,10 +1337,10 @@
       <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> (<option>-F</option>) switch:</para>
+        <option>--file (-F)</option> option:</para>
 
       <screen>
-$ svn commit --file logmsg
+$ svn commit -F logmsg
 Sending        sandwich.txt
 Transmitting file data .
 Committed revision 4.
@@ -1383,7 +1380,7 @@
         that one or more of your files is out-of-date:</para>
 
       <screen>
-$ svn commit --message "Add another rule"
+$ svn commit -m "Add another rule"
 Sending        rules.txt
 svn: Commit failed (details follow):
 svn: Your file or directory 'sandwich.txt' is probably out-of-date
@@ -1496,15 +1493,14 @@
         <emphasis>reverse chronological order</emphasis> by default.
         If you wish to see a different range of revisions in a
         particular order, or just a single revision, pass the
-        <option>--revision</option> (<option>-r</option>)
-        switch:</para>
+        <option>--revision (-r)</option> option:</para>
 
       <screen>
-$ svn log --revision 5:19    # shows logs 5 through 19 in chronological order
+$ svn log -r 5:19    # shows logs 5 through 19 in chronological order
 
-$ svn log --revision 19:5    # shows logs 5 through 19 in reverse order
+$ svn log -r 19:5    # shows logs 5 through 19 in reverse order
 
-$ svn log --revision 8       # shows log for revision 8
+$ svn log -r 8       # shows log for revision 8
 </screen>
 
       <para>You can also examine the log history of a single file or
@@ -1523,15 +1519,14 @@
 
       <para>If you want even more information about a file or
         directory, <command>svn log</command> also takes a
-        <option>--verbose</option> (<option>-v</option>) switch.
-        Because Subversion allows you to move and copy files and
-        directories, it is important to be able to track path changes
-        in the filesystem, so in verbose mode, <command>svn
-        log</command> will include a list of changed paths in a
-        revision in its output:</para>
+        <option>--verbose (-v)</option> option.  Because Subversion
+        allows you to move and copy files and directories, it is
+        important to be able to track path changes in the filesystem,
+        so in verbose mode, <command>svn log</command> will include a
+        list of changed paths in a revision in its output:</para>
 
       <screen>
-$ svn log --revision 8 --verbose
+$ svn log -r 8 -v
 ------------------------------------------------------------------------
 r8 | sally | 2002-07-14 08:15:29 -0500 | 1 line
 Changed paths:
@@ -1646,7 +1641,7 @@
           repository.</para>
 
         <screen>
-$ svn diff --revision 3 rules.txt
+$ svn diff -r 3 rules.txt
 Index: rules.txt
 ===================================================================
 --- rules.txt	(revision 3)
@@ -1668,12 +1663,11 @@
         <title>Comparing Repository to Repository</title>
 
         <para>If two revision numbers, separated by a colon, are
-          passed via <option>--revision</option>
-          (<option>-r</option>), then the two revisions are directly
-          compared.</para>
+          passed via <option>--revision (-r)</option>, then the two
+          revisions are directly compared.</para>
 
         <screen>
-$ svn diff --r 2:3 rules.txt
+$ svn diff -r 2:3 rules.txt
 Index: rules.txt
 ===================================================================
 --- rules.txt	(revision 2)
@@ -1688,8 +1682,8 @@
 </screen>
 
         <para>A more convenient way of comparing a revision to the
-          previous revision is to use the <option>--change</option>
-          (<option>-c</option>):</para>
+          previous revision is to use the <option>--change (-c)</option>:
+          </para>
 
         <screen>
 $ svn diff -c 3 rules.txt
@@ -1715,7 +1709,7 @@
           on your local machine:</para>
 
         <screen>
-$ svn diff --revision 4:5 http://svn.example.com/repos/example/trunk/text/rules.txt
+$ svn diff -c 5 http://svn.example.com/repos/example/trunk/text/rules.txt
 …
 $
 </screen>
@@ -1744,7 +1738,7 @@
           <command>svn cat</command>:</para>
 
         <screen>
-$ svn cat --revision 2 rules.txt
+$ svn cat -r 2 rules.txt
 Be kind to others
 Freedom = Chocolate Ice Cream
 Everything in moderation
@@ -1756,7 +1750,7 @@
           file:</para>
 
         <screen>
-$ svn cat --revision 2 rules.txt > rules.txt.v2
+$ svn cat -r 2 rules.txt > rules.txt.v2
 $
 </screen>
 
@@ -1780,11 +1774,11 @@
 </screen>
 
         <para>If you want a more detailed listing, pass the
-          <option>--verbose</option> (<option>-v</option>) flag to get
-          output like this:</para>
+          <option>--verbose (-v)</option> flag to get output like
+          this:</para>
 
         <screen>
-$ svn list --verbose http://svn.collab.net/repos/svn
+$ svn list -v http://svn.collab.net/repos/svn
   20620 harry            1084 Jul 13  2006 README
   23339 harry                 Feb 04 01:40 branches/
   21282 sally                 Aug 27 09:41 developer-resources/
@@ -1813,9 +1807,9 @@
         machine.</para></footnote>:</para>
 
       <screen>
-$ svn checkout --revision 1729 # Checks out a new working copy at r1729
+$ svn checkout -r 1729 # Checks out a new working copy at r1729
 …
-$ svn update --revision 1729 # Updates an existing working copy to r1729
+$ svn update -r 1729 # Updates an existing working copy to r1729
 …
 </screen>
 
@@ -1841,7 +1835,7 @@
       <screen>
 $ svn export http://svn.example.com/svn/repos1 # Exports latest revision
 …
-$ svn export http://svn.example.com/svn/repos1 --revision 1729
+$ svn export http://svn.example.com/svn/repos1 -r 1729
 # Exports revision r1729
 …
 </screen>

Modified: trunk/src/en/book/ch03-advanced-topics.xml
==============================================================================
--- trunk/src/en/book/ch03-advanced-topics.xml	(original)
+++ trunk/src/en/book/ch03-advanced-topics.xml	Mon Feb 26 21:47:28 2007
@@ -92,7 +92,7 @@
       <para>The Subversion client understands a number of
         <firstterm>revision keywords</firstterm>.  These keywords can
         be used instead of integer arguments to the
-        <option>--revision</option> switch, and are resolved into
+        <option>--revision (-r)</option> switch, and are resolved into
         specific revision numbers by Subversion:</para>
 
       <variablelist>
@@ -187,7 +187,7 @@
       <para>Revision numbers reveal nothing about the world outside
         the version control system, but sometimes you need to
         correlate a moment in real time with a moment in version
-        history.  To facilitate this, the <option>--revision</option>
+        history.  To facilitate this, the <option>--revision (-r)</option>
         option can also accept as input date specifiers wrapped in
         curly braces (<literal>{</literal> and <literal>}</literal>).
         Subversion accepts the standard ISO-8601 date and time
@@ -467,8 +467,7 @@
         have a multi-line textual, or even binary, property value, you
         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
+        <option>--file (-F)</option> option for specifying the name of
         a file which contains the new property value.</para>
 
       <screen>
@@ -554,7 +553,7 @@
         <option>--verbose</option> (<option>-v</option>) option.</para>
 
       <screen>
-$ svn proplist --verbose calc/button.c
+$ svn proplist -v calc/button.c
 Properties on 'calc/button.c':
   copyright : (c) 2006 Red-Bean Software
   license : ================================================================
@@ -580,7 +579,7 @@
       <screen>
 $ svn propset license '' calc/button.c
 property 'license' set on 'calc/button.c'
-$ svn proplist --verbose calc/button.c
+$ svn proplist -v calc/button.c
 Properties on 'calc/button.c':
   copyright : (c) 2006 Red-Bean Software
   license : 
@@ -594,7 +593,7 @@
       <screen>
 $ svn propdel license calc/button.c
 property 'license' deleted from 'calc/button.c'.
-$ svn proplist --verbose calc/button.c
+$ svn proplist -v calc/button.c
 Properties on 'calc/button.c':
   copyright : (c) 2006 Red-Bean Software
 $
@@ -1842,14 +1841,14 @@
         the <command>svn lock</command> command.</para>
 
       <screen>
-$ svn lock banana.jpg --message "Editing file for tomorrow's release."
+$ svn lock banana.jpg -m "Editing file for tomorrow's release."
 'banana.jpg' locked by user 'harry'.
 $
 </screen>
 
       <para>There are a number of new things demonstrated in the
         previous example.  First, notice that Harry passed the
-        <option>--message</option> option to <command>svn
+        <option>--message (-m)</option> option to <command>svn
         lock</command>.  Similar to <command>svn commit</command>, the
         <command>svn lock</command> command can take comments (either
         via <option>--message (-m)</option> or <option>--file
@@ -2016,7 +2015,7 @@
         these is <command>svn status --show-updates</command>:</para>
 
       <screen>
-$ svn status --show-updates
+$ svn status -u
 M              23   bar.c
 M    O         32   raisin.jpg
        *       72   foo.h
@@ -2125,7 +2124,7 @@
         command:</para>
 
       <screen>
-$ svn status --show-updates
+$ svn status -u
 M              23   bar.c
 M    O         32   raisin.jpg
        *       72   foo.h
@@ -2185,7 +2184,7 @@
       <screen>
 $ svn status
      K raisin.jpg
-$ svn status --show-updates
+$ svn status -u
      B         32   raisin.jpg
 $ svn update
   B  raisin.jpg

Modified: trunk/src/en/book/ch04-branching-and-merging.xml
==============================================================================
--- trunk/src/en/book/ch04-branching-and-merging.xml	(original)
+++ trunk/src/en/book/ch04-branching-and-merging.xml	Mon Feb 26 21:47:28 2007
@@ -342,7 +342,7 @@
 $ pwd
 /home/user/my-calc-branch
 
-$ svn log --verbose integer.c
+$ svn log -v integer.c
 ------------------------------------------------------------------------
 r343 | user | 2002-11-07 15:27:56 -0600 (Thu, 07 Nov 2002) | 2 lines
 Changed paths:
@@ -387,7 +387,7 @@
 $ pwd
 /home/sally/calc
 
-$ svn log --verbose integer.c
+$ svn log -v integer.c
 ------------------------------------------------------------------------
 r344 | sally | 2002-11-07 15:27:56 -0600 (Thu, 07 Nov 2002) | 2 lines
 Changed paths:
@@ -1151,7 +1151,7 @@
         <para>So in our continuing example,</para>
 
         <screen>
-$ svn log --verbose --stop-on-copy \
+$ svn log -v --stop-on-copy \
           http://svn.example.com/repos/calc/branches/my-calc-branch
 …
 ------------------------------------------------------------------------
@@ -1409,7 +1409,7 @@
         discover the exact coordinate pair you wish to resurrect.  A
         good strategy is to run <command>svn log
         --verbose</command> in a directory which used to contain your
-        deleted item.  The <option>--verbose</option> option shows a
+        deleted item.  The <option>--verbose (-v)</option> option shows a
         list of all changed items in each revision; all you need to do
         is find the revision in which you deleted the file or
         directory.  You can do this visually, or by using another tool
@@ -1418,7 +1418,7 @@
 
       <screen>
 $ cd parent-dir
-$ svn log --verbose
+$ svn log -v
 …
 ------------------------------------------------------------------------
 r808 | joe | 2003-12-26 14:29:40 -0600 (Fri, 26 Dec 2003) | 3 lines

Modified: trunk/src/en/book/ch06-server-configuration.xml
==============================================================================
--- trunk/src/en/book/ch06-server-configuration.xml	(original)
+++ trunk/src/en/book/ch06-server-configuration.xml	Mon Feb 26 21:47:28 2007
@@ -587,11 +587,11 @@
           (2000, 2003, XP, Vista), then you can
           run <command>svnserve</command> as a standard Windows
           service.  This is typically a much nicer experience than
-          running it as a standalone daemon with
-          the <option>-d</option> option.  Using daemon-mode requires
-          launching a console, typing a command, and then leaving the
-          console window running indefinitely.  A Windows service,
-          however, runs in the background, can start at boot time
+          running it as a standalone daemon with the <option>--daemon
+          (-d)</option> option.  Using daemon-mode requires launching
+          a console, typing a command, and then leaving the console
+          window running indefinitely.  A Windows service, however,
+          runs in the background, can start at boot time
           automatically, and can be started and stopped using the same
           consistent administration interface as other
           services. </para>
@@ -621,8 +621,8 @@
           the <option>--service</option> option.  You must always
           specify this option, and you may <emphasis>not</emphasis>
           specify other conflicting options such
-          as <option>--daemon</option>, <option>--tunnel</option>,
-          or <option>--inetd</option>.  Options such
+          as <option>--daemon (-d)</option>, <option>--tunnel</option>,
+          or <option>--inetd (-i)</option>.  Options such
           as <option>-r</option> or <option>--listen-port</option> are
           fine.  Second, be careful about spaces when invoking
           the <command>SC.EXE</command> command: the
@@ -2060,13 +2060,14 @@
 
           <para>So to answer the question, one obvious way to see
             older revisions of files and directories is by passing the
-            <option>--revision</option> argument to the <command>svn
-            list</command> and <command>svn cat</command> commands.
-            To browse old revisions with your web browser, however,
-            you can use third-party software.  A good example of this
-            is ViewVC (<ulink url="http://viewvc.tigris.org/"/>).
-            ViewVC was originally written to display CVS repositories
-            through the web,
+            <option>--revision (-r)</option> argument to
+            the <command>svn list</command> and <command>svn
+            cat</command> commands.  To browse old revisions with your
+            web browser, however, you can use third-party software.  A
+            good example of this is ViewVC
+            (<ulink url="http://viewvc.tigris.org/"/>).  ViewVC was
+            originally written to display CVS repositories through the
+            web,
             <footnote>
               <para>Back then, it was called <quote>ViewCVS</quote>.</para>
             </footnote>




More information about the svnbook-dev mailing list