[svnbook] r4346 committed - For issue 5 ("Document svnmucc"), begin fleshing out the reference...

svnbook at googlecode.com svnbook at googlecode.com
Mon Jan 21 13:30:53 CST 2013


Revision: 4346
Author:   cmpilato at gmail.com
Date:     Mon Jan 21 11:30:40 2013
Log:      For issue 5 ("Document svnmucc"), begin fleshing out the reference
material for svnmucc.

* en/book/ch09-reference.xml
   (svn.ref.svnmucc): Document svnmucc's Actions and Options in new
     subsections of this section.  Leave a placeholder section for
     Examples, too.

http://code.google.com/p/svnbook/source/detail?r=4346

Modified:
  /trunk/en/book/ch09-reference.xml

=======================================
--- /trunk/en/book/ch09-reference.xml	Mon Jan 21 07:56:05 2013
+++ /trunk/en/book/ch09-reference.xml	Mon Jan 21 11:30:40 2013
@@ -11041,13 +11041,320 @@
            revision.</refpurpose>
        </refnamediv>

+      <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
-->
        <refsect1 id="svn.ref.svnmucc.re.syn">
          <title>Synopsis</title>
          <para><literal>svnmucc ACTION...</literal></para>
        </refsect1>

-      <!-- ### TODO: Write this section! See                        -->
-      <!-- ### https://code.google.com/p/svnbook/issues/detail?id=5 -->
+      <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
-->
+      <refsect1 id="svn.ref.svnmucc.re.desc">
+        <title>Description</title>
+
+        <para><command>svnmucc</command> is a program for modifying
+          Subversion-versioned data without the use of a working copy.
+          It allows operations to be performed directly against the
+          repository URLs of the files and directories that the user
+          wishes to change.  Each invocation of <command>svnmucc</command>
+          attempts one or more <replaceable>ACTION</replaceable>s,
+          atomically committing the results of those combined
+          <replaceable>ACTION</replaceable>s as a single new
+          revision.</para>
+
+      </refsect1>
+
+      <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
-->
+      <refsect1 id="svn.ref.svnmucc.re.actions">
+        <title>Actions</title>
+
+        <para><command>svnmucc</command> supports the following
+          actions (and related arguments), which may be combined into
+          ordered sequences on the command line:</para>
+
+        <variablelist>
+
+          <varlistentry>
+            <term>cp <replaceable>REV</replaceable>
+              <replaceable>SRC-URL</replaceable>
+              <replaceable>DST-URL</replaceable></term>
+            <listitem>
+              <para>Copy the file or directory located
+                at <replaceable>SRC-URL</replaceable> in
+                revision <replaceable>REV</replaceable>
+                to <replaceable>DST-URL</replaceable>.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term>mkdir <replaceable>URL</replaceable></term>
+            <listitem>
+              <para>Create a new directory at  
<replaceable>URL</replaceable>.
+                The parent directory of <replaceable>URL</replaceable>
+                must already exist (or have been created by a
+                prior <command>svnmucc</command> action), as this
+                command does not offer the ability to automatically
+                create any missing intermediate parent
+                directories.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term>mv <replaceable>SRC-URL</replaceable>
+              <replaceable>DST-URL</replaceable></term>
+            <listitem>
+              <para>Move the file or directory located
+                at <replaceable>SRC-URL</replaceable> to
+                <replaceable>DST-URL</replaceable>.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term>rm <replaceable>URL</replaceable></term>
+            <listitem>
+              <para>Delete the file or directory located
+                at <replaceable>URL</replaceable>.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term>put <replaceable>SRC-FILE</replaceable>
+              <replaceable>URL</replaceable></term>
+            <listitem>
+              <para>Add a new file—or modify an existing
+                one—located at <replaceable>URL</replaceable>,
+                copying the contents of the local file
+                <replaceable>SRC-FILE</replaceable> as the new contents
+                of the created or modified file.  As a special
+                consideration, <replaceable>SRC-FILE</replaceable> may
+                be <literal>-</literal> to instruct
+                <command>svnmucc</command> to read from standard input
+                rather than a local filesystem file.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term>propsetf <replaceable>NAME</replaceable>
+              <replaceable>VALUE</replaceable>
+              <replaceable>URL</replaceable></term>
+            <listitem>
+              <para>Set the value of the
+                property <replaceable>NAME</replaceable> on the
+                target <replaceable>URL</replaceable>
+                to <replaceable>VALUE</replaceable>.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term>propsetf <replaceable>NAME</replaceable>
+              <replaceable>FILE</replaceable>
+              <replaceable>URL</replaceable></term>
+            <listitem>
+              <para>Set the value of the
+                property <replaceable>NAME</replaceable> on the
+                target <replaceable>URL</replaceable>
+                to the contents of the file
+                <replaceable>FILE</replaceable>.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term>propdel <replaceable>NAME</replaceable>
+              <replaceable>URL</replaceable></term>
+            <listitem>
+              <para>Delete the property <replaceable>NAME</replaceable>
+                from the target <replaceable>URL</replaceable>.</para>
+            </listitem>
+          </varlistentry>
+
+        </variablelist>
+      </refsect1>
+
+      <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
-->
+      <refsect1 id="svn.ref.svnmucc.re.sw">
+        <title>Options</title>
+
+        <para>Options specified on the <command>svnmucc</command>
+          command line are global to all actions performed by that
+          command line.  The following is a list of the options
+          supported by this tool:</para>
+
+        <variablelist>
+
+          <varlistentry>
+            <term><option>--config-dir</option>
+              <replaceable>DIR</replaceable></term>
+            <listitem>
+              <para>Read configuration information from the specified
+                directory instead of the default location
+                (<filename>.subversion</filename> in the user's home
+                directory).</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--config-option</option>
+              <replaceable>CONFSPEC</replaceable></term>
+            <listitem>
+              <para>Set, for the duration of the command, the value
+                of a runtime configuration option.
+                <replaceable>CONFSPEC</replaceable> is a
+                string which specifies the configuration option
+                namespace, name and value that you'd like to assign,
+                formatted as
+                 
<replaceable>FILE</replaceable>:<replaceable>SECTION</replaceable>:<replaceable>OPTION</replaceable>=[<replaceable>VALUE</replaceable>].
+                In this syntax, <replaceable>FILE</replaceable>
+                and <replaceable>SECTION</replaceable> are the runtime
+                configuration file (either <literal>config</literal>
+                or <literal>servers</literal>) and the section
+                thereof, respectively, which contain the option whose
+                value you wish to
+                change.  <replaceable>OPTION</replaceable> is, of
+                course, the option itself,
+                and <replaceable>VALUE</replaceable> the value (if
+                any) you wish to assign to the option.  For example,
+                to temporarily disable the use of the automatic
+                property setting feature,
+                use  
<option>--config-option=config:miscellany:enable-auto-props=no</option>.
+                You can use this option multiple times to change
+                multiple option values simultaneously.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--extra-args</option> (<option>-X</option>)
+              <replaceable>ARGFILE</replaceable></term>
+            <listitem>
+              <para>Read additional would-be command-line arguments
+                from <replaceable>ARGFILE</replaceable>, one argument
+                per line.  As a special consideration,
+                <replaceable>ARGFILE</replaceable> may be
+                <literal>-</literal> to indicate that additional
+                arguments should be read instead from standard
+                input.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--file</option> (<option>-F</option>)
+              <replaceable>MSGFILE</replaceable></term>
+            <listitem>
+               <para>Use the contents of the  
<replaceable>MSGFILE</replaceable>
+                 as the log message for the commit.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--help</option> (<option>-h</option>,
+              <option>-?</option>)</term>
+            <listitem>
+               <para>Show program usage information and exit.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--message</option> (<option>-m</option>)
+              <replaceable>MSG</replaceable></term>
+            <listitem>
+               <para>Use <replaceable>MSG</replaceable> as the log
+                 message for the commit.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--no-auth-cache</option></term>
+            <listitem>
+              <para>Prevent caching of authentication information
+                (e.g., username and password) in the Subversion
+                runtime configuration directories.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--non-interactive</option></term>
+            <listitem>
+              <para>Disable all interactive prompting (e.g., requests
+                for authentication credentials).</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--revision</option> (<option>-r</option>)
+              <replaceable>REV</replaceable></term>
+            <listitem>
+              <para>Use revision <replaceable>REV</replaceable> as the
+                baseline revision for all changes made via
+                the <command>svnmucc</command> actions.  This is an
+                important option which users should habituate to using
+                correctly in order to avoid inadvertently undoing
+                contemporary changes made by fellow team members.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--root-url</option> (<option>-U</option>)
+              <replaceable>ROOT-URL</replaceable></term>
+            <listitem>
+              <para>Use <replaceable>ROOT-URL</replaceable> as a base
+                URL to which all other URL targets are relative.  This
+                URL need not be the repository's root URL (such
+                as might be reported by <command>svn info</command>).
+                It can be any URL common to the various targets which
+                are specified in the <command>svnmucc</command>
+                actions.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--password</option> (<option>-p</option>)
+              <replaceable>PASSWD</replaceable></term>
+            <listitem>
+              <para>Use <replaceable>PASSWD</replaceable> as the
+                password when authenticating against a Subversion
+                server.  If not provided, or if incorrect, Subversion
+                will prompt you for this information as needed.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--username</option>
+              <replaceable>NAME</replaceable></term>
+            <listitem>
+              <para>Use <replaceable>USERNAME</replaceable> as the
+                username when authenticating against a Subversion
+                server.  If not provided, or if incorrect, Subversion
+                will prompt you for this information as needed.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--version</option></term>
+            <listitem>
+              <para>Display the program's version information and
+                exit.</para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--with-revprop</option>
+               
<replaceable>NAME</replaceable>=<replaceable>VALUE</replaceable></term>
+            <listitem>
+              <para>Set the value of the revision property
+                <replaceable>NAME</replaceable> to
+                <replaceable>VALUE</replaceable> on the committed
+                revision.</para>
+            </listitem>
+          </varlistentry>
+
+        </variablelist>
+      </refsect1>
+
+      <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -  
-->
+      <refsect1 id="svn.ref.svnmucc.re.examples">
+        <title>Examples</title>
+
+        <para>### TODO ###</para>
+
+      </refsect1>

      </refentry>
    </sect1>




More information about the svnbook-dev mailing list