From owner-svn-doc-head@FreeBSD.ORG Mon Aug 20 12:08:50 2012 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 662EB1065676; Mon, 20 Aug 2012 12:08:50 +0000 (UTC) (envelope-from gjb@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c]) by mx1.freebsd.org (Postfix) with ESMTP id 3F3438FC14; Mon, 20 Aug 2012 12:08:50 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q7KC8orJ031760; Mon, 20 Aug 2012 12:08:50 GMT (envelope-from gjb@svn.freebsd.org) Received: (from gjb@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q7KC8oOM031758; Mon, 20 Aug 2012 12:08:50 GMT (envelope-from gjb@svn.freebsd.org) Message-Id: <201208201208.q7KC8oOM031758@svn.freebsd.org> From: Glen Barber Date: Mon, 20 Aug 2012 12:08:50 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cc: Subject: svn commit: r39399 - head/en_US.ISO8859-1/books/handbook/cutting-edge X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 20 Aug 2012 12:08:50 -0000 Author: gjb Date: Mon Aug 20 12:08:49 2012 New Revision: 39399 URL: http://svn.freebsd.org/changeset/doc/39399 Log: Update the cutting-edge chapter for obtaining/updating the FreeBSD Documentation Project sources to reflect the CVS->SVN conversion. Submitted by: ryusuke (originally) Modified: head/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml Modified: head/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml ============================================================================== --- head/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml Sun Aug 19 23:05:52 2012 (r39398) +++ head/en_US.ISO8859-1/books/handbook/cutting-edge/chapter.sgml Mon Aug 20 12:08:49 2012 (r39399) @@ -736,14 +736,12 @@ Fetching 133 new ports or files... done. shipped with each release by maintaining a local copy of the latest &os; Documentation Set. - - Using CVSup to Update the Documentation + + Using <application>Subversion</application> to Update the Documentation - The sources and the installed copy of the &os; documentation - can be updated with CVSup, using a - mechanism similar to the one employed for the base system - sources (c.f. ). This section - describes: + The &os; documentation sources can be obtained with + Subversion. This section + describes: @@ -755,7 +753,7 @@ Fetching 133 new ports or files... done. How to download a copy of the documentation source at /usr/doc, - using CVSup. + using Subversion. @@ -775,7 +773,7 @@ Fetching 133 new ports or files... done. - Installing CVSup and the Documentation Toolchain + Installing <application>Subversion</application> and the Documentation Toolchain Rebuilding the &os; documentation from source requires a fairly large collection of tools. These tools are not part of @@ -804,68 +802,34 @@ Fetching 133 new ports or files... done. necessary. - For more information on installing and using - CVSup, see Using CVSup. + Subversion is installed with + the textproc/docproj + port. Updating the Documentation Sources - The CVSup utility can fetch a - clean copy of the documentation sources, using - the /usr/share/examples/cvsup/doc-supfile - file as a configuration template. The default update host is - set to a placeholder value in doc-supfile, - but &man.cvsup.1; accepts a host name through the command line, - so the documentation sources can be fetched from one of the - CVSup servers by typing: - - &prompt.root; cvsup -h cvsup.FreeBSD.org -g -L 2 /usr/share/examples/cvsup/doc-supfile - - Change cvsup.FreeBSD.org to the - nearest CVSup server. See for a complete listing of mirror - sites. + The Subversion program can fetch a + clean copy of the documentation sources by typing: + + &prompt.root; svn checkout svn://svn.FreeBSD.org/doc/head /usr/doc The initial download of the documentation sources may take a while. Let it run until it completes. Future updates of the documentation sources may be fetched - by running the same command. - The CVSup utility downloads and - copies only the updates since the last time it ran, so every run - of CVSup after the first complete run - should be pretty fast. + by running: + + &prompt.root; svn update /usr/doc After checking out the sources, an alternative way of updating the documentation is supported by the Makefile of the /usr/doc directory. By setting - SUP_UPDATE, SUPHOST and - DOCSUPFILE in the - /etc/make.conf file, it is possible to - run: + class="directory">/usr/doc directory by running: &prompt.root; cd /usr/doc &prompt.root; make update - - A typical set of these &man.make.1; options - for /etc/make.conf is: - - SUP_UPDATE= yes -SUPHOST?= cvsup.freebsd.org -DOCSUPFILE?= /usr/share/examples/cvsup/doc-supfile - - - Setting the SUPHOST - and DOCSUPFILE value - with ?= permits overriding them in the - command-line of make. This is the recommended way of adding - options to make.conf, to avoid having to - edit the file every time a different option value has to be - tested. - @@ -904,15 +868,6 @@ DOCSUPFILE?= /usr/share/examples/cvsup/d - SUPHOST - - - The hostname of the CVSup - server to use when updating. - - - - DOCDIR @@ -947,15 +902,6 @@ DOCSUPFILE?= /usr/share/examples/cvsup/d &prompt.root; cd /usr/doc &prompt.root; make install clean - If make.conf has been set up with the - correct DOCSUPFILE, SUPHOST - and SUP_UPDATE options, the install step may - be combined with an update of the documentation sources by - typing: - - &prompt.root; cd /usr/doc -&prompt.root; make update install clean - If an update of only a specific language is desired, &man.make.1; can be invoked in a language specific subdirectory of /usr/doc, i.e.: @@ -997,7 +943,7 @@ DOCSUPFILE?= /usr/share/examples/cvsup/d though. Building the documentation sources requires a fairly large collection of tools and utilities, the documentation toolchain, a certain level of - familiarity with CVS and source + familiarity with Subversion and source checkouts from a repository, and a few manual steps to build the checked out sources. In this section, we describe an alternative way of updating the installed copies of the &os; @@ -1129,7 +1075,7 @@ DOCSUPFILE?= /usr/share/examples/cvsup/d Notice that the default target directory differs from the directory used by the - CVSup method. This is + Subversion method. This is because we are installing a port, and ports are usually installed under the /usr/local directory.