[svnbook commit] r3532 - Add short options after using long options in prose, per HACKING.

codesite-noreply at google.com codesite-noreply at google.com
Fri May 29 06:45:16 CDT 2009


Author: julianfoad at btopenworld.com
Date: Fri May 29 04:44:12 2009
New Revision: 3532

Modified:
    trunk/src/en/book/ch01-fundamental-concepts.xml
    trunk/src/en/book/ch02-basic-usage.xml
    trunk/src/en/book/ch03-advanced-topics.xml
    trunk/src/en/book/ch06-server-configuration.xml
    trunk/src/en/book/ch09-reference.xml

Log:
Add short options after using long options in prose, per HACKING.

* src/en/book/ch01-fundamental-concepts.xml,
* src/en/book/ch02-basic-usage.xml,
* src/en/book/ch03-advanced-topics.xml,
* src/en/book/ch06-server-configuration.xml,
* src/en/book/ch09-reference.xml
   Add short options after long options.

Patch by: Larry Shatzer, Jr. <larrys {_AT_} gmail.com>


Modified: trunk/src/en/book/ch01-fundamental-concepts.xml
==============================================================================
--- trunk/src/en/book/ch01-fundamental-concepts.xml	(original)
+++ trunk/src/en/book/ch01-fundamental-concepts.xml	Fri May 29 04:44:12 2009
@@ -876,8 +876,9 @@
            of revisions.  Even if you're the only person using the
            repository, you will still see this phenomenon.  To examine
            your mixture of working revisions, use the <command>svn
-          status</command> command with the <option>--verbose</option>  
option (see <xref
-          linkend="svn.tour.cycle.examine.status"/> for more
+          status</command> command with the <option>--verbose</option>
+          (<option>-v</option>) option (see
+          <xref linkend="svn.tour.cycle.examine.status"/> for more
            information).</para>

          <para>Often, new users are completely unaware that their

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	Fri May 29 04:44:12 2009
@@ -1655,11 +1655,12 @@
  </screen>

        <para>If you fail to specify either the
-        <option>--message</option> or <option>--file</option> option,
-        Subversion will automatically launch your favorite editor
-        (see the information on <literal>editor-cmd</literal> in
-        <xref linkend="svn.advanced.confarea.opts.config"/>) for composing  
a log
-        message.</para>
+        <option>--message</option> (<option>-m</option>)
+        or <option>--file</option> (<option>-F</option>) option,
+        Subversion will automatically launch your favorite editor (see
+        the information on <literal>editor-cmd</literal> in
+        <xref linkend="svn.advanced.confarea.opts.config"/>) for
+        composing a log message.</para>

        <tip>
          <para>If you're in your editor writing a commit message and
@@ -1878,9 +1879,10 @@
  </screen>

        <para>
-        <command>svn log</command> also takes a <option>--quiet</option>
-        (<option>-q</option>) option, which suppresses the body of the
-        log message.  When combined with <option>--verbose</option>, it
+        <command>svn log</command> also takes
+        a <option>--quiet</option> (<option>-q</option>) option, which
+        suppresses the body of the log message.  When combined
+        with <option>--verbose</option> (<option>-v</option>), it
          gives just the names of the changed files.</para>

        <sidebar>
@@ -2146,8 +2148,9 @@

        <para>In addition to all of the previous commands, you can use
          <command>svn update</command> and <command>svn
-        checkout</command> with the <option>--revision</option> option
-        to take an entire working copy <quote>back in time</quote>:
+        checkout</command> with the <option>--revision</option>
+        (<option>-r</option>) option to take an entire working
+        copy <quote>back in time</quote>:
          <footnote>
            <para>See?  We told you that Subversion was a time  
machine.</para>
          </footnote>
@@ -2178,8 +2181,8 @@
          sans <filename>.svn</filename> directories.  As
          with <command>svn update</command> and
          <command>svn checkout</command>, you can also pass the
-        <option>--revision</option> option to <command>svn
-        export</command>:</para>
+        <option>--revision</option> (<option>-r</option>) option
+        to <command>svn export</command>:</para>

        <screen>
  $ svn export http://svn.example.com/svn/repos1 # Exports latest revision

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	Fri May 29 04:44:12 2009
@@ -2651,9 +2651,9 @@
  </screen>

        <para>If the repository lock was broken, then <userinput>svn
-        status --show-updates</userinput> displays a
-        <literal>B</literal> (Broken) symbol next to the file.  If a
-        new lock exists in place of the old one, then a
+        status --show-updates</userinput> (<option>-u</option>)
+        displays a <literal>B</literal> (Broken) symbol next to the
+        file.  If a new lock exists in place of the old one, then a
          <literal>T</literal> (sTolen) symbol is shown.  Finally,
          <command>svn update</command> notices any defunct lock tokens
          and removes them from the working copy.</para>

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	Fri May 29 04:44:12 2009
@@ -614,14 +614,14 @@
            (2000, 2003, XP, or Vista), 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>--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
-          Windows services. </para>
+          running it as a standalone daemon with
+          the <option>--daemon</option> (<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 automatically, and can be
+          started and stopped using the same consistent administration
+          interface as other Windows services. </para>

          <para>You'll need to define the new service using the
            command-line tool <command>SC.EXE</command>.  Much like
@@ -649,10 +649,12 @@
            <option>--service</option> option.  Any other options to
            <command>svnserve</command> must then be specified on the
            same line, but you cannot add conflicting 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, though.  Second, be careful about spaces when invoking
+          <option>--daemon</option>
+          (<option>-d</option>), <option>--tunnel</option>,
+          or <option>--inetd</option> (<option>-i</option>).  Options
+          such as <option>-r</option>
+          or <option>--listen-port</option> are fine, though.  Second,
+          be careful about spaces when invoking
            the <command>SC.EXE</command> command: the <literal>key=
            value</literal> patterns must have no spaces between
            <literal>key=</literal> and must have exactly one space
@@ -2249,13 +2251,13 @@
            log</command>.  When retrieving a list of revisions, the
            server looks at every changed path in each revision and
            checks it for readability.  If an unreadable path is
-          discovered, it's omitted from the list of the
-          revision's changed paths (normally seen with
-          the <option>--verbose</option> option), and the whole log
-          message is suppressed.  Needless to say, this can be
-          time-consuming on revisions that affect a large number of
-          files.  This is the cost of security: even if you haven't
-          configured a module such as
+          discovered, it's omitted from the list of the revision's
+          changed paths (normally seen with
+          the <option>--verbose</option> (<option>-v</option>) option),
+          and the whole log message is suppressed.  Needless to say,
+          this can be time-consuming on revisions that affect a large
+          number of files.  This is the cost of security: even if you
+          haven't configured a module such as
            <command>mod_authz_svn</command> at all, the
            <command>mod_dav_svn</command> module is still asking Apache
            <command>httpd</command> to run authorization checks on

Modified: trunk/src/en/book/ch09-reference.xml
==============================================================================
--- trunk/src/en/book/ch09-reference.xml	(original)
+++ trunk/src/en/book/ch09-reference.xml	Fri May 29 04:44:12 2009
@@ -1375,10 +1375,11 @@
          <refsect1>
            <title>Description</title>

-          <para>Send changes from your working copy to the
-            repository.  If you do not supply a log message with your
-            commit by using either the <option>--file</option> or
-            <option>--message</option> option,
+          <para>Send changes from your working copy to the repository.
+            If you do not supply a log message with your commit by
+            using either the <option>--file</option>
+            (<option>-F</option>) or <option>--message</option>
+            (<option>-m</option>) option,
              <command>svn</command> will launch your editor for you
              to compose a commit message.  See the
              <literal>editor-cmd</literal> list entry in <xref
@@ -1466,17 +1467,17 @@
  Committed revision 5.
  </screen>

-          <para>If you want to use a file that's under version
-            control for your commit message with
-            <option>--file</option>, you need to pass the
+          <para>If you want to use a file that's under version control
+            for your commit message with <option>--file</option>
+            (<option>-F</option>), you need to pass the
              <option>--force-log</option> option:</para>

            <screen>
-$ svn commit --file file_under_vc.txt foo.c
+$ svn commit -F file_under_vc.txt foo.c
  svn: The log message file is under version control
  svn: Log message file is a versioned file; use '--force-log' to override

-$ svn commit --force-log --file file_under_vc.txt foo.c
+$ svn commit --force-log -F file_under_vc.txt foo.c
  Sending        foo.c
  Transmitting file data .
  Committed revision 6.
@@ -2095,9 +2096,9 @@
  </screen>

            <para>Use <option>--diff-cmd</option>
-            <replaceable>CMD</replaceable> <option>-x</option> to
-            pass arguments directly to the external diff
-            program:</para>
+            <replaceable>CMD</replaceable> <option>--extensions</option>
+            (<option>-x</option>) to pass arguments directly to the
+            external diff program:</para>

            <screen>
  $ svn diff --diff-cmd /usr/bin/diff -x "-i -b" COMMITTERS
@@ -2624,9 +2625,9 @@
              repository URL of the current working copy
              directory.</para>

-          <para>With <option>--verbose</option>, <command>svn
-            list</command> shows the following fields for each
-            item:</para>
+          <para>With <option>--verbose</option>
+            (<option>-v</option>), <command>svn list</command> shows
+            the following fields for each item:</para>

            <itemizedlist>
              <listitem><para>Revision number of the last
@@ -2643,11 +2644,11 @@
                commit</para></listitem>
            </itemizedlist>

-          <para>With <option>--xml</option>, output is in XML format (with
-            a header and an enclosing document element unless
-            <option>--incremental</option> is also specified).  All of the
-            information is present; the <option>--verbose</option> option
-            is not accepted.</para>
+          <para>With <option>--xml</option>, output is in XML format
+            (with a header and an enclosing document element unless
+            <option>--incremental</option> is also specified).  All of
+            the information is present; the <option>--verbose</option>
+            (<option>-v</option>) option is not accepted.</para>
          </refsect1>

          <refsect1>
@@ -2693,8 +2694,9 @@
  …
  </screen>

-          <para>You can pass the <option>--verbose</option> option for
-            additional information, rather like the Unix command
+          <para>You can pass the <option>--verbose</option>
+            (<option>-v</option>) option for additional information,
+            rather like the Unix command
              <command>ls -l</command>:</para>

            <screen>
@@ -2865,11 +2867,14 @@
              under that URL will be printed.  The default revision range
              for a URL is <literal>HEAD:1</literal>.</para>

-          <para>With <option>--verbose</option>, <command>svn log</command>
-            will also print all affected paths with each log message.
-            With <option>--quiet</option>, <command>svn log</command>
-            will not print the log message body itself (this is
-            compatible with <option>--verbose</option>).</para>
+          <para>With <option>--verbose</option>
+            (<option>-v</option>), <command>svn log</command> will
+            also print all affected paths with each log message.
+            With <option>--quiet</option>
+            (<option>-q</option>), <command>svn log</command> will not
+            print the log message body itself, this is compatible
+            with <option>--verbose</option>
+            (<option>-v</option>).</para>

            <para>Each log message is printed just once, even if more
              than one of the affected paths for that revision were
@@ -2978,12 +2983,12 @@
  …
  </screen>

-          <para>The <option>--verbose</option> option causes
-            <command>svn log</command> to include information about
-            the paths that were changed in each displayed revision.
-            These paths appear, one path per line of output, with
-            action codes that indicate what type of change was made to
-            the path.</para>
+          <para>The <option>--verbose</option> (<option>-v</option>)
+            option causes <command>svn log</command> to include
+            information about the paths that were changed in each
+            displayed revision.  These paths appear, one path per line
+            of output, with action codes that indicate what type of
+            change was made to the path.</para>

            <screen>
  $ svn log -v http://svn.red-bean.com/repos/test/ foo.c bar.c
@@ -3031,9 +3036,11 @@
            </variablelist>

            <para>In addition to the action codes which precede the
-            changed paths, <command>svn log</command> with the  
<option>--verbose</option> option will
-            note whether a path was added or replaced as the result of a  
copy
-            operation.  It does so by printing <literal>(from
+            changed paths, <command>svn log</command> with
+            the <option>--verbose</option> (<option>-v</option>)
+            option will note whether a path was added or replaced as
+            the result of a copy operation.  It does so by
+            printing <literal>(from
               
<replaceable>COPY-FROM-PATH</replaceable>:<replaceable>COPY-FROM-REV</replaceable>)</literal>
              after such paths.</para>

@@ -3903,9 +3910,10 @@
    owner
  </screen>

-          <para>But with the <option>--verbose</option> flag, <command>svn
-            proplist</command> is extremely handy as it also shows you the
-            values for the properties:</para>
+          <para>But with the <option>--verbose</option>
+            (<option>-v</option>) flag, <command>svn
+            proplist</command> is extremely handy as it also shows you
+            the values for the properties:</para>

            <screen>
  $ svn proplist -v foo.c
@@ -4435,11 +4443,12 @@
            <para>Print the status of working copy files and
              directories.  With no arguments, it prints only locally
              modified items (no repository access).  With
-            <option>--show-updates</option>, it adds working revision
-            and server out-of-date information.  With
-            <option>--verbose</option>, it prints full revision
-            information on every item.  With <option>--quiet</option>,
-            it prints only summary information about locally modified
+            <option>--show-updates</option> (<option>-u</option>), it
+            adds working revision and server out-of-date information.
+            With <option>--verbose</option> (<option>-v</option>), it
+            prints full revision information on every item.
+            With <option>--quiet</option> (<option>-q</option>), it
+            prints only summary information about locally modified
              items.</para>

            <para>The first seven columns in the output are each one
@@ -4644,11 +4653,12 @@
              <varlistentry>
                <term><literal>' '</literal></term>
                <listitem>
-                <para>When <option>--show-updates</option> is used,
-                the file is not locked.  If
-                <option>--show-updates</option> is
-                <emphasis>not</emphasis> used, this merely means that
-                the file is not locked in this working copy.</para>
+                <para>When <option>--show-updates</option>
+                  (<option>-u</option>) is used, the file is not
+                  locked.  If <option>--show-updates</option>
+                  (<option>-u</option>) is <emphasis>not</emphasis>
+                  used, this merely means that the file is not locked
+                  in this working copy.</para>
                </listitem>
              </varlistentry>

@@ -4664,7 +4674,8 @@
                <listitem>
                  <para>File is locked either by another user or in
                  another working copy.  This appears only when
-                <option>--show-updates</option> is used.</para>
+                <option>--show-updates</option>
+                (<option>-u</option>) is used.</para>
                </listitem>
              </varlistentry>

@@ -4674,8 +4685,8 @@
                  <para>File was locked in this working copy, but the
                  lock has been <quote>stolen</quote> and is invalid.
                  The file is currently locked in the repository.  This
-                appears only when <option>--show-updates</option> is
-                used.</para>
+                appears only when <option>--show-updates</option>
+                (<option>-u</option>) is used.</para>
                </listitem>
              </varlistentry>

@@ -4683,9 +4694,10 @@
                <term>B</term>
                <listitem>
                  <para>File was locked in this working copy, but the
-                lock has been <quote>broken</quote> and is invalid.
-                The file is no longer locked.  This appears only when
-                <option>--show-updates</option> is used.</para>
+                  lock has been <quote>broken</quote> and is invalid.
+                  The file is no longer locked.  This appears only
+                  when <option>--show-updates</option>
+                  (<option>-u</option>) is used.</para>
                </listitem>
              </varlistentry>

@@ -4716,7 +4728,8 @@

            <para>The out-of-date information appears in the ninth
              column (only if you pass the
-            <option>--show-updates</option> option):</para>
+            <option>--show-updates</option> (<option>-u</option>)
+            option):</para>

            <variablelist>

@@ -4737,14 +4750,16 @@

            </variablelist>

-          <para>The remaining fields are variable width and
-            delimited by spaces.  The working revision is the next
-            field if the <option>--show-updates</option> or
-            <option>--verbose</option> option is passed.</para>
-
-          <para>If the <option>--verbose</option> option is passed,
-            the last committed revision and last committed author
-            are displayed next.</para>
+          <para>The remaining fields are variable width and delimited
+            by spaces.  The working revision is the next field if
+            the <option>--show-updates</option> (<option>-u</option>)
+            or <option>--verbose</option> (<option>-v</option>) option
+            is passed.</para>
+
+          <para>If the <option>--verbose</option>
+            (<option>-v</option>) option is passed, the last committed
+            revision and last committed author are displayed
+            next.</para>

            <para>The working copy path is always the final field, so
              it can include spaces.</para>
@@ -4763,7 +4778,8 @@

          <refsect1>
            <title>Accesses repository</title>
-          <para>Only if using <option>--show-updates</option></para>
+          <para>Only if using <option>--show-updates</option>
+          (<option>-u</option>)</para>
          </refsect1>

          <refsect1>
@@ -4795,10 +4811,10 @@
  </screen>

            <para>If you want to find out what files in your working
-            copy are out of date, pass the
-            <option>--show-updates</option> option (this will
-            <emphasis>not</emphasis> make any changes to your
-            working copy).  Here you can see that
+            copy are out of date, pass
+            the <option>--show-updates</option> (<option>-u</option>)
+            option (this will <emphasis>not</emphasis> make any
+            changes to your working copy).  Here you can see that
              <filename>wc/foo.c</filename> has changed in the
              repository since we last updated our working
              copy:</para>
@@ -4813,14 +4829,16 @@

            <note>
              <para><option>--show-updates</option>
-              <emphasis>only</emphasis> places an asterisk next to
-              items that are out of date (i.e., items that will be
-              updated from the repository if you later use <command>svn
-              update</command>).  <option>--show-updates</option> does
-              <emphasis>not</emphasis> cause the status listing to
-              reflect the repository's version of the item (although
-              you can see the revision number in the repository by
-              passing the <option>--verbose</option> option).</para>
+              (<option>-u</option>) <emphasis>only</emphasis> places
+              an asterisk next to items that are out of date (i.e.,
+              items that will be updated from the repository if you
+              later use <command>svn update</command>).
+              <option>--show-updates</option> (<option>-u</option>)
+              does <emphasis>not</emphasis> cause the status listing
+              to reflect the repository's version of the item
+              (although you can see the revision number in the
+              repository by passing the <option>--verbose</option>
+              (<option>-v</option>) option).</para>
            </note>

            <para>The most information you can get out of
@@ -5470,7 +5488,7 @@
          </varlistentry>

          <varlistentry>
-          <term><option>--quiet</option></term>
+          <term><option>--quiet</option> (<option>-q</option>)</term>
            <listitem>
              <para>Do not show normal progress—show only
                errors.</para>
@@ -7464,7 +7482,8 @@
            <title>Description</title>

            <para>List the properties of a path in the repository.  With
-            <option>--verbose</option>, show the property values  
too.</para>
+            <option>--verbose</option> (<option>-v</option>), show the
+            property values too.</para>

            </refsect1>





More information about the svnbook-dev mailing list