docs/171292: [PATCH] handbook should describe subversion for src in preference to CVS
Lowell Gilbert
lgfbsd at be-well.ilk.org
Mon Sep 3 20:30:09 UTC 2012
>Number: 171292
>Category: docs
>Synopsis: [PATCH] handbook should describe subversion for src in preference to CVS
>Confidential: no
>Severity: serious
>Priority: medium
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Mon Sep 03 20:30:08 UTC 2012
>Closed-Date:
>Last-Modified:
>Originator: Lowell Gilbert
>Release: FreeBSD 9.1-PRERELEASE amd64
>Organization:
FreeBSD Users
>Environment:
System: FreeBSD lowell-desk.lan 9.1-PRERELEASE FreeBSD 9.1-PRERELEASE #21: Fri Aug 31 22:35:59 EDT 2012 root at lowell-desk.lan:/usr/obj/usr/src/sys/LOWELL64 amd64
>Description:
The Handbook still describes updating sources through CVS, but Subversion is replacing it as the 9.1 branch will not be exported to CVS.
>How-To-Repeat:
See "cutting edge" section of Handbook.
>Fix:
This is, at the least, a start...
Index: en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml
===================================================================
--- en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml (revision 39493)
+++ en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml (working copy)
@@ -118,6 +118,12 @@
the port <filename>net/cvsup-without-gui</filename>).
You may wish to substitute this
with &man.csup.1;, which is part of the base system.</para>
+ <para>The use of <command>cvsup</command> is slowly being
+ obsoleted as <command>subversion</command> replaces the use
+ of <command>cvs</command> for the project's underlying
+ version control structure. New installations are discouraged
+ from using <command>cvsup</command>/<command>csup</command>,
+ and encouraged to use <command>svn</command> instead.</para>
</note>
</sect1>
@@ -1376,35 +1382,26 @@
</indexterm>
<listitem>
- <para>Use the <link linkend="cvsup">cvsup</link> program
- with the <filename>supfile</filename> named
- <filename>standard-supfile</filename>
- available from
- <filename>/usr/share/examples/cvsup</filename>.
+ <para>Use the <application>Subversion</application> program.
This is the most recommended method, since it allows you to
grab the entire collection once and then only what has
changed from then on. Many people run
- <command>cvsup</command> from <command>cron</command> and
- keep their sources up-to-date automatically. You have to
- customize the sample <filename>supfile</filename> above,
- and configure <link
- linkend="cvsup">cvsup</link> for your environment.</para>
-
+ <command>subversion</command> from <command>cron</command> and
+ keep their sources up-to-date automatically.
<note>
- <para>The sample <filename>standard-supfile</filename> is
- intended for tracking a specific security branch of
- &os;, and not &os.current;. You will need to edit this
- file and replace the following line:</para>
+ <para>There is no version-control "tag" for the
+ &os.current; branch of &os;.
+ The command line for
+ using <command>subversion</command> to retrieve
+ &os.current; is
+ <screen>&prompt.root; <userinput>svn checkout <literal>svn://svn.FreeBSD.org/base/head</literal> <filename class="directory">/usr/src</filename></userinput></screen>
- <programlisting>*default release=cvs tag=RELENG_<replaceable>X</replaceable>_<replaceable>Y</replaceable></programlisting>
-
- <para>With this one:</para>
-
- <programlisting>*default release=cvs tag=.</programlisting>
-
- <para>For a detailed explanation of usable tags, please
+ <para>Similar procedures apply for other development
+ branches and tags: for a detailed explanation of usable tags, please
refer to the Handbook's <link
- linkend="cvs-tags">CVS Tags</link> section.</para>
+ linkend="cvs-tags">CVS Tags</link> section,
+ which is still roughly appropriate
+ for <application>Subversion</application>.</para>
</note>
</listitem>
@@ -1567,10 +1564,13 @@
<para>If you are already running a previous release of &os;
and wish to upgrade via sources then you can easily do so
from &os; <link linkend="mirrors">mirror site</link>. This can
- be done in one of two ways:</para>
+ be done in one of several ways:</para>
<orderedlist>
<indexterm>
+ <primary><command>subversion</command></primary>
+ </indexterm>
+ <indexterm>
<primary><command>cvsup</command></primary>
</indexterm>
<indexterm>
@@ -1581,11 +1581,31 @@
<secondary>syncing with <application>CVSup</application></secondary>
</indexterm>
<listitem>
+ <para>Use the <command>subversion</command> program
+ with the appropriate &os.stable; tag for the
+ sources on the branch you prefer.
+ This is the most recommended method, since it allows you to
+ grab the entire collection once and then only what has
+ changed from then on. Many people run the
+ <command>subversion</command> from <command>cron</command> to
+ keep their sources up-to-date automatically.
+ The command line for
+ using <command>subversion</command> to
+ retrieve &os.stable; is
+ <screen>&prompt.root; <userinput>svn checkout <literal>svn://svn.FreeBSD.org/base/stable/9</literal> <filename class="directory">/usr/src</filename></userinput></screen>
+ as long as 9.x is the &os.stable; branch.
+ </para>
+ </listitem>
+
+ <listitem>
<para>Use the <link linkend="cvsup">cvsup</link> program
with the <filename>supfile</filename> named
<filename>stable-supfile</filename> from the directory
<filename>/usr/share/examples/cvsup</filename>.
- This is the most recommended method, since it allows you to
+ This method is becoming obsolescent, but is still
+ appropriate for &os; versions before
+ 9.1. Like <command>subversion</command>, it allows
+ you to
grab the entire collection once and then only what has
changed from then on. Many people run
<command>cvsup</command> from <command>cron</command> to
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-doc
mailing list