svn commit: r42100 - head/en_US.ISO8859-1/articles/committers-guide

Warren Block wblock at
Sun Jun 30 23:11:05 UTC 2013

Author: wblock
Date: Sun Jun 30 23:11:05 2013
New Revision: 42100

  Change 'svn switch --relocate' to 'svn relocate'.
  Use &os; in reference to $FreeBSD$ version string.
  Rewrite some sections that had defined svn operations in terms of
  what CVS did so they can stand alone.
  Remove confusing reference to 'svn rmdir', which does not, in fact,
  actually exist.


Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml
--- head/en_US.ISO8859-1/articles/committers-guide/article.xml	Sun Jun 30 23:00:47 2013	(r42099)
+++ head/en_US.ISO8859-1/articles/committers-guide/article.xml	Sun Jun 30 23:11:05 2013	(r42100)
@@ -466,11 +466,11 @@
 	  using <command>svnsync</command>.</para>
 	<para>There is a serious disadvantage to this method: every
-	  time something is to be committed, a <command>svn switch
-	    --relocate</command> to the master repository has to be
-	  done, remembering to <command>svn switch</command> back to
+	  time something is to be committed, a
+	  <command>svn relocate</command> to the master repository has to be
+	  done, remembering to <command>svn relocate</command> back to
 	  the mirror after the commit.  Also, since <command>svn
-	    switch</command> only works between repositories that have
+	    relocate</command> only works between repositories that have
 	  the same UUID, some hacking of the local repository's UUID
 	  has to occur before it is possible to start using it.</para>
@@ -800,13 +800,13 @@
 	  <para>Most new source files should include a
-	    <literal>$FreeBSD$</literal> string in the
+	    <literal>$&os;$</literal> string in the
 	    new file.  On commit, <command>svn</command> will expand
-	    the <literal>$FreeBSD$</literal> string,
+	    the <literal>$&os;$</literal> string,
 	    adding the file path, revision number, date and time of
 	    commit, and the username of the committer.  Files which
 	    cannot be modified may be committed without the
-	    <literal>$FreeBSD$</literal> string.</para>
+	    <literal>$&os;$</literal> string.</para>
 	<para>Files can be removed with <command>svn
@@ -830,12 +830,9 @@
 	<screen>&prompt.user; <userinput>svn mkdir <replaceable>bar</replaceable></userinput></screen>
-	<para>The directory is not immediately
-	  created in the repository when you use <command>svn
-	    mkdir</command>.  Subversion
-	  allows directories to be removed using <command>svn
-	    rm</command>, however there is no <command>svn
-	    rmdir</command>:</para>
+	<para>Like files, directories are removed with
+	  <command>svn rm</command>.  There is no separate command
+	  specifically for removing directories.</para>
 	<screen>&prompt.user; <userinput>svn rm <replaceable>bar</replaceable></userinput></screen>
@@ -843,13 +840,13 @@
       <sect3 id="svn-daily-use-copying-and-moving">
 	<title>Copying and Moving Files</title>
-	<para>The command creates a copy of
-	  <filename>foo.c</filename>, named
+	<para>This command creates a copy of
+	  <filename>foo.c</filename> named
 	  <filename>bar.c</filename>, with the new file also under version control:</para>
 	<screen>&prompt.user; <userinput>svn copy <replaceable>foo.c</replaceable> <replaceable>bar.c</replaceable></userinput></screen>
-	<para><command>svn cp</command> is equivalent to:</para>
+	<para>The example above is equivalent to:</para>
 	<screen>&prompt.user; <userinput>cp foo.c bar.c</userinput>
 &prompt.user; <userinput>svn add bar.c</userinput></screen>
@@ -862,25 +859,22 @@
       <sect3 id="svn-daily-use-log-and-annotate">
 	<title>Log and Annotate</title>
-	<para><command>svn log</command> will show all the
-	  revisions that affect a directory and files within that
-	  directory in reverse chronological order, if run on a
-	  directory.  This contrasts with <command>cvs log</command>
-	  in that <acronym>CVS</acronym> shows the complete log for
-	  each file in the directory, including duplicate entries for
-	  revisions that affect multiple files.</para>
+	<para><command>svn log</command> shows revisions and
+	  commit messages, most recent first, for files or directories.  When used on a directory, all
+	  revisions that affected the directory and files within that
+	  directory are shown.</para>
 	<para><command>svn annotate</command>, or equally <command>svn
-	    praise</command> or <command>svn blame</command>, is
-	  equivalent to <command>cvs annotate</command> in everything
-	  but output format.</para>
+	    praise</command> or <command>svn blame</command>, shows
+	  the most recent revision number and who committed that
+	  revision for each line of a file.</para>
       <sect3 id="svn-daily-use-diffs">
 	<para><command>svn diff</command> displays changes to the
-	  working copy of the repository.  Diffs generated by
+	  working copy.  Diffs generated by
 	  <acronym>SVN</acronym> are unified
 	  and include new files by default
 	  in the diff output.</para>
@@ -905,14 +899,14 @@
 	<para>Local changes (including additions and deletions) can be
 	  reverted using <command>svn revert</command>.
 	  It does not update out-of-date
-	  files—it just replaces them with pristine copies of
+	  files, but just replaces them with pristine copies of
 	  the original version.</para>
       <sect3 id="svn-daily-use-conflicts">
-	<para>If a <command>svn update</command> resulted in a merge
+	<para>If an <command>svn update</command> resulted in a merge
 	  conflict, Subversion will remember which files have
 	  conflicts and refuse to commit any changes to those files
 	  until explicitly told that the conflicts have been resolved.
@@ -964,24 +958,12 @@
       <sect3 id="svn-advanced-use-sparse-checkouts">
 	<title>Sparse Checkouts</title>
-	<para>The equivalent to <command>cvs checkout -l</command>,
-	  which checks out a directory without its subdirectories, is
-	  <command>svn checkout -N</command>.  Unlike
-	  <acronym>CVS</acronym>, <acronym>SVN</acronym> remembers the
-	  <literal>-N</literal> so that a <command>svn
-	    update</command> does not end up pulling down the
-	  subdirectories.  In Subversion 1.5 and newer,
-	  <literal>-N</literal> has been deprecated in favour of the
-	  <literal>--depth</literal> option which allows for precise
-	  control.  Therefore:</para>
+	<para><acronym>SVN</acronym> allows
+	  <emphasis>sparse</emphasis>, or partial checkouts of a
+	  directory by adding <option>--depth</option> to a
+	  <command>svn checkout</command>.</para>
-	<screen>&prompt.user; <userinput>svn checkout -N svn+ssh:// ~/freebsd</userinput></screen>
-	<para>is equivalent to:</para>
-	<screen>&prompt.user; <userinput>svn checkout --depth=empty svn+ssh:// ~/freebsd</userinput></screen>
-	<para>Valid arguments to <literal>--depth</literal>
+	<para>Valid arguments to <option>--depth</option>
@@ -1024,7 +1006,7 @@
 	  <filename>ROADMAP.txt</filename> and empty subdirectories,
 	  and nothing will happen when <command>svn update</command>
 	  is executed on the subdirectories.  However, the following
-	  command will set the depth for head (in this case) to
+	  command will set the depth for <replaceable>head</replaceable> (in this case) to
 	  infinity, and fully populate it:</para>
 	<screen>&prompt.user; <userinput>svn update --set-depth=infinity <replaceable>head</replaceable></userinput></screen>
@@ -1034,7 +1016,7 @@
 	<title>Direct Operation</title>
 	<para>Certain operations can be performed directly on the
-	  repository, without touching the working copy.
+	  repository without touching the working copy.
 	  Specifically, this applies to any operation that does not
 	  require editing a file, including:</para>

More information about the svn-doc-all mailing list