svn commit: r38887 - head/en_US.ISO8859-1/books/fdp-primer/translations

[Benjamin Kaduk]

On Fri, 25 May 2012, Glen Barber wrote:

> Modified: head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml
> ==============================================================================
> --- head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml	Fri May 25 14:40:55 2012	(r38886)
> +++ head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml	Fri May 25 16:44:43 2012	(r38887)
> @@ -133,21 +133,28 @@
>
>       <answer>
> 	<para>It is strongly recommended that you maintain a local
> -	  copy of the FreeBSD CVS repository (at least the
> -	  documentation part) either using
> -	  <application>CTM</application> or
> -	  <application>CVSup</application>.  The "Staying current with
> -	  FreeBSD" chapter in the Handbook explains how to use these
> -	  applications.</para>
> +	  copy of the FreeBSD Subversion repository (at least the
> +	  documentation part).  This can be done by running:</para>
> +
> +	<screen>&prompt.user; <userinput><command>svn</command> checkout svn://svn.FreeBSD.org/doc/head/ head</userinput></screen>
> +
> +	<note>
> +	  <para>This will require the <filename
> +	      role="package">devel/subversion</filename> package to
> +	    be installed.</para>
> +	</note>
>
> 	<para>You should be comfortable using
> -	  <application>CVS</application>.  This will allow you to see
> +	  <application>svn</application>.  This will allow you to see
> 	  what has changed between different versions of the files
> 	  that make up the documentation.</para>
>
> -	<para>[XXX To Do -- write a tutorial that shows how to use
> -	  CVSup to get just the documentation, check it out, and see
> -	  what has changed between two arbitrary revisions]</para>
> +	<para>For example, to view the differences between revisions
> +	  <literal>r33733</literal> and <literal>r33734</literal> of
> +	  <filename>en_US.ISO8859-1/books/fdp-primer/book.sgml</filename>,
> +	  run:</para>
> +
> +	<screen>&prompt.user; <userinput><command>svn</command> diff -r<replaceable>33733</replaceable>:<replaceable>33734</replaceable> <filename>en_US.ISO8859-1/books/fdp-primer/book.sgml</filename></userinput></screen>
>       </answer>
>     </qandaentry>
>

This particular example might be done more quickly using 'svn diff 
cv33734', but I do not think the documentation should use that form of the 
command, since it is less general.
I think I would prefer if the example had non-contiguous version numbers, 
which might also be a good place to mention that this will happen 
frequently due to the global nature of Subversion's versioning.

I might remember to turn these comments into a patch when I dig out from 
under my bloated INBOX...

-Ben