Date: Fri, 25 May 2012 16:44:43 +0000 (UTC) From: Glen Barber <gjb@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r38887 - head/en_US.ISO8859-1/books/fdp-primer/translations Message-ID: <201205251644.q4PGihZt021547@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: gjb Date: Fri May 25 16:44:43 2012 New Revision: 38887 URL: http://svn.freebsd.org/changeset/doc/38887 Log: Update fdp-primer/translations/chapter.sgml to reflect the CVS->SVN conversion, plus some additional fixes: - Update CVS-specific notes with SVN-specific counterparts - Provide an in-document example of a checkout from svn - Note devel/subversion is required - Replace a TODO item with an example of how to obtain a diff between two versions of a file - Replace "?" with "." at the end of a non-question - Replace "doc/" with "head/" as the top-level directory where necessary - Add the new "htdocs/" directory to the sample sv_SE directory layout - Update sample FreeBSD RCS IDs to the svn-style Modified: head/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml 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> @@ -237,7 +244,7 @@ <para>We are a translation team, and want to submit documentation that our members have translated for - us?</para> + us.</para> </question> <answer> @@ -246,7 +253,7 @@ documentation tree and build straight away.</para> <para>Currently, the FreeBSD documentation is stored in a top - level directory called <filename>doc/</filename>. + level directory called <filename>head/</filename>. Directories below this are named according to the language code they are written in, as defined in ISO639 (<filename>/usr/share/misc/iso639</filename> on a version of @@ -262,9 +269,11 @@ <para>For example, a hypothetical Swedish translation might look like:</para> - <programlisting>doc/ + <programlisting>head/ sv_SE.ISO8859-1/ Makefile + htdocs/ + docproj/ books/ faq/ Makefile @@ -440,14 +449,14 @@ <programlisting><!-- The FreeBSD Documentation Project - $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v 1.5 2000/07/07 18:38:38 dannyboy Exp $ + $FreeBSD: head/en_US.ISO8859-1/books/faq/book.sgml 38674 2012-04-14 13:52:52Z $ --></programlisting> <para>The exact boilerplate may change, but it will always include a $FreeBSD$ line and the phrase <literal>The FreeBSD Documentation Project</literal>. Note that the $FreeBSD part is expanded automatically - by CVS, so it should be empty (just + by Subversion, so it should be empty (just <literal>$FreeBSD$</literal>) for new files.</para> @@ -465,8 +474,8 @@ <programlisting><!-- The FreeBSD Spanish Documentation Project - $FreeBSD: doc/es_ES.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v 1.3 1999/06/24 19:12:32 jesusr Exp $ - Original revision: 1.11 + $FreeBSD: head/es_ES.ISO8859-1/books/faq/book.sgml 38826 2012-05-17 19:12:14Z hrs $ + Original revision: r38674 --></programlisting> </answer> </qandaentry>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201205251644.q4PGihZt021547>