Date: Mon, 1 Oct 2012 16:17:54 +0200 (CEST) From: Beat Gätzi <beat@FreeBSD.org> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/172210: [handbook] [patch] Update ports chapter to reflect CVSup deprecation Message-ID: <201210011417.q91EHsAB036685@tinderbox.chruetertee.ch> Resent-Message-ID: <201210011420.q91EK2FI005804@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 172210 >Category: docs >Synopsis: [handbook] [patch] Update ports chapter to reflect CVSup deprecation >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: update >Submitter-Id: current-users >Arrival-Date: Mon Oct 01 14:20:01 UTC 2012 >Closed-Date: >Last-Modified: >Originator: Beat Gätzi >Release: FreeBSD 10.0-CURRENT i386 >Organization: >Environment: System: FreeBSD tinderbox.chruetertee.ch 10.0-CURRENT FreeBSD 10.0-CURRENT #1 r237414M: Fri Jun 22 10:55:48 CEST 2012 root@tinderbox.chruetertee.ch:/usr/obj/usr/home/beat/dev/src/head/sys/BEASTIE i386 >Description: Attached patch changes the default mechanism for fetching the ports tree to portsnap and adds information how to check out the ports tree using Subversion. It also adds a deprecation warning for CVSup. This patch is based on a patch from rwatson@. >How-To-Repeat: >Fix: --- handbook-ports-using-svn.patch begins here --- Index: en_US.ISO8859-1/books/handbook/ports/chapter.xml =================================================================== --- en_US.ISO8859-1/books/handbook/ports/chapter.xml (Revision 39635) +++ en_US.ISO8859-1/books/handbook/ports/chapter.xml (Arbeitskopie) @@ -616,6 +616,15 @@ system. The detailed description of available <command>make</command> targets and environment variables is available in &man.ports.7;.</para> + <warning> + <para>As of late 2012, the FreeBSD Ports Project is in the process of + migrating revision control systems from CVS to Subversion. As a + result, these instructions are in a state of change. The preferred + mechanism for general ports use is Portsnap; users requiring local + customization of ports (e.g., additional patches) will prefer to use + Subversion directly. The CVSup service is being phased out as of 28 + February 2013, and its use is discouraged.</para></warning> + <sect2 id="ports-tree"> <title>Obtaining the Ports Collection</title> @@ -632,8 +641,107 @@ collection:</para> <procedure> + <title>Portsnap Method</title> + + <para><application>Portsnap</application> is a fast and user-friendly + system for distributing the Ports Collection. + Please refer to <link linkend="updating-upgrading-portsnap">Using Portsnap</link> + for a detailed description of all <application>Portsnap</application> + features.</para> + + <step> + <para>Download a compressed snapshot of the Ports Collection into + <filename class="directory">/var/db/portsnap</filename>. You can + disconnect from the Internet after this step, if you wish.</para> + + <screen>&prompt.root; <userinput>portsnap fetch</userinput></screen> + </step> + + <step> + <para>If you are running <application>Portsnap</application> for the + first time, extract the snapshot into <filename + class="directory">/usr/ports</filename>: + </para> + + <screen>&prompt.root; <userinput>portsnap extract</userinput></screen> + + <para>If you already have a populated <filename + class="directory">/usr/ports</filename> and you are just updating, + run the following command instead:</para> + + <screen>&prompt.root; <userinput>portsnap update</userinput></screen> + </step> + + </procedure> + + <procedure> + <title>Subversion Method</title> + + <para>If more control over the ports tree is needed (e.g maintaining + local changes) <application>Subversion</application> can be used for + obtaining the Ports Collection. Please refer to <ulink + url="&url.articles.committers-guide;/subversion-primer.html">the + Subversion Primer</ulink> for a detailed description of all + <application>Subversion</application> features.</para> + + <step> + <para>To check out the ports tree with <application>Subversion + </application> it needs to be installed first. If you already have + a copy of the ports tree install <application>Subversion + </application>like this:</para> + + <screen>&prompt.root; <userinput>cd /usr/ports/devel/subversion + </userinput> +&prompt.root; <userinput>make install clean</userinput></screen> + + <para>If no ports tree is available <application>Subversion + </application> can be installed via packages:</para> + + <screen>&prompt.root; <userinput>pkg_add -r subversion</userinput> + </screen> + + <para>If <application>pkgng</application> is used for packages + <application>Subversion</application> can be installed using + pkgng:</para> + + <screen>&prompt.root; <userinput>pkg install subversion + </userinput></screen> + </step> + + <step> + <para>Check out an initial copy of the ports tree. Using one of + the provided <ulink + url="&url.books.handbook;/mirrors-svn.html">Subversion + mirrors</ulink> instead of svn.FreeBSD.org is prefered. + Committers should read <ulink + url="&url.articles.committers-guide;/subversion-primer.html">the + Subversion Primer</ulink> prior to checkout as they might have + to check out the ports tree using a different protocol. + </para> + + <screen>&prompt.root; <userinput>svn checkout svn://<replaceable>svn.FreeBSD.org</replaceable>/ports/head /usr/ports</userinput> + </screen> + </step> + + <step> + <para>If you already have a checked out <filename + class="directory">/usr/ports</filename> and you are just updating, + run the following command instead:</para> + + <screen>&prompt.root; <userinput>cd /usr/ports</userinput> +&prompt.root; <userinput>svn update</userinput></screen> + </step> + + </procedure> + + <procedure> <title>CVSup Method</title> + <warning><para>The CVSup method of retrieving and synchronizing the + ports collection is being deprecated as part of a migration to + Subversion. While it remains supported, the service will be + discontinued as of 28 February 2013.</para></warning> + <para>This is a quick method for getting and keeping your copy of the Ports Collection up to date using <application>CVSup</application> protocol. If you want to learn more about @@ -710,40 +818,6 @@ </procedure> <procedure> - <title>Portsnap Method</title> - - <para><application>Portsnap</application> is an alternative system for - distributing the Ports Collection. - Please refer to <link linkend="updating-upgrading-portsnap">Using Portsnap</link> - for a detailed description of all <application>Portsnap</application> - features.</para> - - <step> - <para>Download a compressed snapshot of the Ports Collection into - <filename class="directory">/var/db/portsnap</filename>. You can - disconnect from the Internet after this step, if you wish.</para> - - <screen>&prompt.root; <userinput>portsnap fetch</userinput></screen> - </step> - - <step> - <para>If you are running <application>Portsnap</application> for the - first time, extract the snapshot into <filename - class="directory">/usr/ports</filename>: - </para> - - <screen>&prompt.root; <userinput>portsnap extract</userinput></screen> - - <para>If you already have a populated <filename - class="directory">/usr/ports</filename> and you are just updating, - run the following command instead:</para> - - <screen>&prompt.root; <userinput>portsnap update</userinput></screen> - </step> - - </procedure> - - <procedure> <title>Sysinstall Method</title> <para>This method involves using <application>sysinstall</application> --- handbook-ports-using-svn.patch ends here --- >Release-Note: >Audit-Trail: >Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201210011417.q91EHsAB036685>