From owner-svn-doc-head@FreeBSD.ORG Sun May 20 00:37:20 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 8150A106566C; Sun, 20 May 2012 00:37:20 +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 2EA3B8FC08; Sun, 20 May 2012 00:37:19 +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 q4K0bJ6k055650; Sun, 20 May 2012 00:37:19 GMT (envelope-from gjb@svn.freebsd.org) Received: (from gjb@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q4K0bJwn055648; Sun, 20 May 2012 00:37:19 GMT (envelope-from gjb@svn.freebsd.org) Message-Id: <201205200037.q4K0bJwn055648@svn.freebsd.org> From: Glen Barber Date: Sun, 20 May 2012 00:37:19 +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 Subject: svn commit: r38842 - head/en_US.ISO8859-1/books/fdp-primer/overview 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: Sun, 20 May 2012 00:37:20 -0000 Author: gjb Date: Sun May 20 00:37:19 2012 New Revision: 38842 URL: http://svn.freebsd.org/changeset/doc/38842 Log: Update the FDP Primer Overview chapter to reflect the CVS->SVN repository conversion: - Update an overview of where (as in, what repository) various parts of the documentation project are located. - Update CVS->Subversion/svn where necessary. - Remove references to CVSup, CTM. - Update commands for checking out the documentation tree. - In an example, prefer to use 'svn export foo bar' instead of 'cp -R foo bar', since the latter will also copy '.svn' directories (if they exist). 'svn export' is much cleaner, and will produce a diff that makes sense. Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml Sat May 19 23:49:28 2012 (r38841) +++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml Sun May 20 00:37:19 2012 (r38842) @@ -133,15 +133,21 @@ - These four groups of documentation are all available in the - FreeBSD CVS tree. This means that the logs of changes to these - files are visible to anyone, and anyone can use a program such - as CVSup or - CTM to keep local copies of this - documentation. + The documentation for the web site, &os; Handbook, and FAQ + are available in the doc/ Subversion + repository, which is located at + svn://svn.FreeBSD.org/doc/. + + Manual pages are available in the src/ + Subversion repository, which is available at + svn://svn.FreeBSD.org/base/. + + This means that the logs of changes to these + files are visible to anyone, and anyone can use + svn to view the changes. In addition, many people have written tutorials or other web - sites relating to FreeBSD. Some of these are stored in the CVS + sites relating to FreeBSD. Some of these are stored in the Subversion repository as well (where the author has agreed to this). In other cases the author has decided to keep his documentation separate from the main FreeBSD repository. The FDP endeavors to @@ -158,11 +164,7 @@ How to maintain an up-to-date local copy of the FreeBSD documentation by maintaining a local copy of the - FreeBSD CVS repository (using CVS - and either CVSup or - CTM) or by using - CVSup to download just a - checked-out copy. + FreeBSD Subversion repository using svn. @@ -191,23 +193,23 @@ Get a local copy of the FreeBSD doc - tree. Either use CVSup in checkout mode - to do this, or get a full copy of the CVS repository - locally. - - If you have the CVS repository locally then as a minimum - you will need to checkout the - doc/share, and - doc/en_US.ISO8859-1/share - directories. + tree using svn. - &prompt.user; cvs checkout doc/share -&prompt.user; cvs checkout doc/en_US.ISO8859-1/share + If network bandwidth or local drive space is a concern, + then at minimum, the head/share and + head/language/share + directories will need to be checked out. For + example: + + &prompt.user; mkdir -p head/share +&prompt.user; mkdir -p head/en_US.ISO8859-1/share +&prompt.user; svn checkout svn://svn.freebsd.org/doc/head/share head/share +&prompt.user; svn checkout svn://svn.freebsd.org/doc/head/en_US.ISO8859-1/share head/en_US.ISO8859-1/share If you have plenty of disk space then you could check out everything. - &prompt.user; cvs checkout doc + &prompt.user; svn checkout svn://svn.freebsd.org/doc/head head @@ -225,7 +227,7 @@ Check out the articles directory. - &prompt.user; cvs checkout doc/en_US.ISO8859-1/articles + &prompt.user; svn checkout svn://svn.freebsd.org/doc/head/en_US.ISO8859-1/articles @@ -234,17 +236,17 @@ belongs in a directory called vpn-w2k. - &prompt.user; cd doc/en_US.ISO8859-1/articles -&prompt.user; cp -R committers-guide vpn-w2k + &prompt.user; cd head/en_US.ISO8859-1/articles +&prompt.user; svn export committers-guide vpn-w2k If you wanted to edit an existing document, such as the FAQ, which is in - doc/en_US.ISO8859-1/books/faq you would + head/en_US.ISO8859-1/books/faq you would check it out of the repository like this. - &prompt.user; cvs checkout doc/en_US.ISO8859-1/books/faq + &prompt.user; svn checkout svn://svn.freebsd.org/doc/head/en_US.ISO8859-1/books/faq @@ -268,7 +270,7 @@ pdf, and rtf are supported. The most up to date list of supported formats is listed at the top of the - doc/share/mk/doc.docbook.mk file. Make + head/share/mk/doc.docbook.mk file. Make sure to use quotes around the list of formats when you build more than one format with a single command.