From beat@tinderbox.chruetertee.ch  Mon Oct  1 14:18:02 2012
Return-Path: <beat@tinderbox.chruetertee.ch>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 167B6106564A
	for <FreeBSD-gnats-submit@freebsd.org>; Mon,  1 Oct 2012 14:18:02 +0000 (UTC)
	(envelope-from beat@tinderbox.chruetertee.ch)
Received: from tinderbox.chruetertee.ch (cl-104.gva-01.ch.sixxs.net [IPv6:2a02:2528:ff00:67::2])
	by mx1.freebsd.org (Postfix) with ESMTP id 73BBD8FC15
	for <FreeBSD-gnats-submit@freebsd.org>; Mon,  1 Oct 2012 14:18:01 +0000 (UTC)
Received: from tinderbox.chruetertee.ch (localhost [127.0.0.1])
	by tinderbox.chruetertee.ch (8.14.5/8.14.5) with ESMTP id q91EHxtv036711
	for <FreeBSD-gnats-submit@freebsd.org>; Mon, 1 Oct 2012 16:17:59 +0200 (CEST)
	(envelope-from beat@tinderbox.chruetertee.ch)
Received: (from beat@localhost)
	by tinderbox.chruetertee.ch (8.14.5/8.14.5/Submit) id q91EHsAB036685;
	Mon, 1 Oct 2012 16:17:54 +0200 (CEST)
	(envelope-from beat)
Message-Id: <201210011417.q91EHsAB036685@tinderbox.chruetertee.ch>
Date: Mon, 1 Oct 2012 16:17:54 +0200 (CEST)
From: Beat Gtzi <beat@freebsd.org>
Reply-To: Beat Gtzi <beat@freebsd.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc:
Subject: [handbook] [patch] Update ports chapter to reflect CVSup deprecation
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         172210
>Category:       docs
>Synopsis:       [handbook] [patch] Update ports chapter to reflect CVSup deprecation
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    wblock
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          update
>Submitter-Id:   current-users
>Arrival-Date:   Mon Oct 01 14:20:01 UTC 2012
>Closed-Date:    Tue Oct 02 16:55:13 UTC 2012
>Last-Modified:  Tue Oct  2 17:00:26 UTC 2012
>Originator:     Beat Gtzi
>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:
Responsible-Changed-From-To: freebsd-doc->wblock 
Responsible-Changed-By: wblock 
Responsible-Changed-When: Mon Oct 1 15:43:44 UTC 2012 
Responsible-Changed-Why:  
Take. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=172210 
State-Changed-From-To: open->closed 
State-Changed-By: wblock 
State-Changed-When: Tue Oct 2 16:54:36 UTC 2012 
State-Changed-Why:  
Modified version of patch committed.  Thanks! 

http://www.freebsd.org/cgi/query-pr.cgi?pr=172210 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/172210: commit references a PR
Date: Tue,  2 Oct 2012 16:51:56 +0000 (UTC)

 Author: wblock
 Date: Tue Oct  2 16:51:46 2012
 New Revision: 39639
 URL: http://svn.freebsd.org/changeset/doc/39639
 
 Log:
   Update ports chapter to reflect CVSup deprecation, add svn information.
   
   PR:		docs/172210
   Submitted by:	Beat Gaetzi <beat@FreeBSD.org>
 
 Modified:
   head/en_US.ISO8859-1/books/handbook/ports/chapter.xml
 
 Modified: head/en_US.ISO8859-1/books/handbook/ports/chapter.xml
 ==============================================================================
 --- head/en_US.ISO8859-1/books/handbook/ports/chapter.xml	Tue Oct  2 14:00:52 2012	(r39638)
 +++ head/en_US.ISO8859-1/books/handbook/ports/chapter.xml	Tue Oct  2 16:51:46 2012	(r39639)
 @@ -616,24 +616,135 @@ docbook                     =
        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
 +	<application>Portsnap</application>.  Users requiring local
 +	customization of ports (that is, maintaining additional local
 +	patches) will probably prefer to use Subversion directly.  The
 +	<application>CVSup</application> service is being phased out
 +	as of February 28, 2013, and further use is
 +	discouraged.</para>
 +    </warning>
 +
      <sect2 id="ports-tree">
        <title>Obtaining the Ports Collection</title>
  
 -      <para>Before you can install ports, you must first obtain the
 -	Ports Collection&mdash;which is essentially a set of
 +      <para>The Ports Collection is a set of
  	<filename>Makefiles</filename>, patches, and description files
 -	placed in <filename>/usr/ports</filename>.
 -      </para>
 +	stored in <filename>/usr/ports</filename>.  This set of files
 +	is used for building and installing applications &os;.  The
 +	instructions below show several methods of obtaining the Ports
 +	Collection if it was not installed during initial &os;
 +	setup.</para>
 +
 +      <procedure>
 +	<title>Portsnap Method</title>
 +
 +	<para><application>Portsnap</application> is a fast and
 +	  user-friendly tool for retrieving the Ports Collection, the
 +	  preferred choice for most users.  See
 +	  <link linkend="updating-upgrading-portsnap">Using
 +	    Portsnap</link> for a detailed description of
 +	  <application>Portsnap</application>.</para>
 +
 +	<step>
 +	  <para>Download a compressed snapshot of the Ports Collection
 +	    into <filename
 +	      class="directory">/var/db/portsnap</filename>.</para>
 +
 +	  <screen>&prompt.root; <userinput>portsnap fetch</userinput></screen>
 +	</step>
 +
 +	<step>
 +	  <para>When 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>After the first use of
 +	    <application>Portsnap</application> has been completed as
 +	    shown above,
 +	    <filename class="directory">/usr/ports</filename> can be
 +	    updated with:</para>
  
 -      <para>When installing your FreeBSD system,
 -	<application>sysinstall</application> asked if you would like
 -	to install the Ports Collection.  If you chose no, you can
 -	follow these instructions to obtain the ports
 -	collection:</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 (for
 +	  example, for maintaining local changes)
 +	  <application>Subversion</application> can be used to
 +	  obtain the Ports Collection.  Refer to <ulink
 +	    url="&url.articles.committers-guide;/subversion-primer.html">the
 +	    Subversion Primer</ulink> for a detailed description of
 +	  <application>Subversion</application>.</para>
 +
 +	<step>
 +	  <para><application>Subversion</application> must be
 +	    installed before it can be used to check out the ports
 +	    tree.  If a copy of the ports tree is already present,
 +	    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 the ports tree is not available,
 +	    <application>Subversion</application> can be installed as
 +	    a package:</para>
 +
 +	  <screen>&prompt.root; <userinput>pkg_add -r subversion</userinput></screen>
 +
 +	  <para>If <application>pkgng</application> is being used to
 +	    manage packages, <application>Subversion</application> can 
 +	    be installed with it instead:</para>
 +
 +	  <screen>&prompt.root; <userinput>pkg install subversion</userinput></screen>
 +	</step>
 +
 +	<step>
 +	  <para>Check out a copy of the ports tree.  Use a specific
 +	    <ulink
 +	      url="&url.books.handbook;/mirrors-svn.html">Subversion
 +	      mirror</ulink> close to your geographic location instead
 +	    of <replaceable>svn.FreeBSD.org</replaceable> in the
 +	    command below for better performance.  Committers should
 +	    read the <ulink
 +	      url="&url.articles.committers-guide;/subversion-primer.html">Subversion
 +	      Primer</ulink> first to be sure the correct protocol is
 +	    chosen.</para>
 +
 +	  <screen>&prompt.root; <userinput>svn checkout svn://<replaceable>svn.FreeBSD.org</replaceable>/ports/head /usr/ports</userinput></screen>
 +	</step>
 +
 +	<step>
 +	  <para>To update
 +	    <filename class="directory">/usr/ports</filename> after
 +	    the initial <application>Subversion</application>
 +	    checkout:</para>
 +
 +	  <screen>&prompt.root; <userinput>svn update /usr/ports</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 +821,6 @@ docbook                     =
        </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>
 _______________________________________________
 svn-doc-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-doc-all
 To unsubscribe, send any mail to "svn-doc-all-unsubscribe@freebsd.org"
 
>Unformatted:
