Date: Thu, 17 Jan 2013 22:37:36 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r40674 - head/en_US.ISO8859-1/books/handbook/mirrors Message-ID: <201301172237.r0HMbaR9026851@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Thu Jan 17 22:37:35 2013 New Revision: 40674 URL: http://svnweb.freebsd.org/changeset/doc/40674 Log: Clarify the Using SVN section. Change the example mirror used, modify the checkout example to point to the SVN mirrors section. Modify terms to be more consistent. Reviewed by: simon (earlier version), pgj Modified: head/en_US.ISO8859-1/books/handbook/mirrors/chapter.xml Modified: head/en_US.ISO8859-1/books/handbook/mirrors/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/mirrors/chapter.xml Thu Jan 17 12:47:38 2013 (r40673) +++ head/en_US.ISO8859-1/books/handbook/mirrors/chapter.xml Thu Jan 17 22:37:35 2013 (r40674) @@ -596,7 +596,9 @@ <title>Running <application>Subversion</application></title> <para>The <command>svn</command> command is used to fetch a - clean copy of the sources into a local directory.</para> + clean copy of the sources into a local directory. The files + in this directory are called a <emphasis>local working + copy</emphasis>.</para> <warning> <para>If the local directory already exists but was not created by <command>svn</command>, rename or delete it @@ -606,14 +608,21 @@ repository.</para> </warning> - <para>Check out from a given repository by typing:</para> + <para>A checkout from a given repository is performed with a + command like this:</para> - <screen>&prompt.root; <userinput>svn checkout <literal>svn://svn.FreeBSD.org/<replaceable>repository</replaceable>/<replaceable>branch</replaceable></literal> <replaceable>root</replaceable></userinput></screen> + <screen>&prompt.root; <userinput>svn checkout <replaceable>svn-mirror</replaceable>/<replaceable>repository</replaceable>/<replaceable>branch</replaceable> <replaceable>lwcdir</replaceable></userinput></screen> <para>where:</para> <itemizedlist> <listitem> + <para><replaceable>svn-mirror</replaceable> is a URL for one + of the <link linkend="svn-mirrors">Subversion mirror + sites</link>.</para> + </listitem> + + <listitem> <para><replaceable>repository</replaceable> is one of the Project repositories, i.e., <literal>base</literal>, <literal>ports</literal>, or <literal>doc</literal>.</para> @@ -634,7 +643,7 @@ </listitem> <listitem> - <para><replaceable>root</replaceable> is the target directory + <para><replaceable>lwcdir</replaceable> is the target directory where the contents of the specified branch should be placed. This is usually <filename class="directory">/usr/ports</filename> for @@ -646,21 +655,45 @@ </listitem> </itemizedlist> - <para>Note that the initial download of the sources may take a - while. Let it run until it completes.</para> - - <para>Future updates of the downloaded sources may be fetched by - running:</para> - - <screen>&prompt.root; <userinput>svn update <replaceable>root</replaceable></userinput></screen> - - <para>After checking out the sources, an alternative way of - updating the documentation is supported by the - <filename>Makefile</filename> of the <filename - class="directory"><replaceable>root</replaceable></filename> - directory by running:</para> + <para>This example checks out the Ports Collection from the + western US repository using the HTTPS protocol, placing the + local working copy in + <filename class="directory">/usr/ports</filename>. If + <filename class="directory">/usr/ports</filename> is already + present but was not created by <command>svn</command>, + remember to rename or delete it before the checkout.</para> + + <screen>&prompt.root; <userinput>svn checkout https://svn0.us-west.FreeBSD.org/head/ports /usr/ports</userinput></screen> + + <para>Because the initial checkout has to download the full + branch of the remote repository, it can take a while. Please + be patient.</para> + + <para>After the initial checkout, the local working copy can be + updated by running:</para> + + <screen>&prompt.root; <userinput>svn update <replaceable>lwcdir</replaceable></userinput></screen> + + <para>To update + <filename class="directory">/usr/ports</filename> created in + the example above, use:</para> + + <screen>&prompt.root; <userinput>svn update /usr/ports</userinput></screen> + + <para>The update is much quicker than a checkout, only + transferring files that have changed.</para> + + <para>An alternate way of + updating the local working copy after checkout is provided by the + <filename>Makefile</filename> in the <filename + class="directory">/usr/ports</filename>, + <filename class="directory">/usr/src</filename>, and + <filename class="directory">/usr/doc</filename> directories. + Set <makevar>SVN_UPDATE</makevar> and use the + <maketarget>update</maketarget> target. For example, to + update <filename class="directory">/usr/src</filename>:</para> - <screen>&prompt.root; <userinput>cd <replaceable>root</replaceable></userinput> + <screen>&prompt.root; <userinput>cd /usr/src</userinput> &prompt.root; <userinput>make update SVN_UPDATE=yes</userinput></screen> </sect2>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201301172237.r0HMbaR9026851>