From owner-svn-doc-head@FreeBSD.ORG Sun May 20 16:15:49 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 80E15106564A; Sun, 20 May 2012 16:15:49 +0000 (UTC) (envelope-from bjk@freebsd.org) Received: from freefall.freebsd.org (freefall.freebsd.org [IPv6:2001:4f8:fff6::28]) by mx1.freebsd.org (Postfix) with ESMTP id 2A84D8FC0C; Sun, 20 May 2012 16:15:48 +0000 (UTC) Received: from freefall.freebsd.org (localhost [127.0.0.1]) by freefall.freebsd.org (8.14.5/8.14.5) with ESMTP id q4KGFmWS059436; Sun, 20 May 2012 16:15:48 GMT (envelope-from bjk@freebsd.org) Received: from localhost (bjk@localhost) by freefall.freebsd.org (8.14.5/8.14.5/Submit) with ESMTP id q4KGFmdj059433; Sun, 20 May 2012 16:15:48 GMT (envelope-from bjk@freebsd.org) X-Authentication-Warning: freefall.freebsd.org: bjk owned process doing -bs Date: Sun, 20 May 2012 16:15:48 +0000 (UTC) From: Benjamin Kaduk To: Glen Barber In-Reply-To: <201205200037.q4K0bJwn055648@svn.freebsd.org> Message-ID: References: <201205200037.q4K0bJwn055648@svn.freebsd.org> User-Agent: Alpine 2.00 (BSF 1167 2008-08-23) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed Cc: svn-doc-head@freebsd.org, svn-doc-all@freebsd.org, doc-committers@freebsd.org Subject: Re: 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 16:15:49 -0000 On Sun, 20 May 2012, Glen Barber wrote: > 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: Thanks for stepping up and doing this. > > - 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. Interestingly, I noted while looking around to remind myself of a few things, that we seem to not document svn as a way to keep src/ up-to-date, in the handbook ("Synchronizing Your Source") -- just CVSup and CTM. Perhaps a todo item? > - 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 > @@ -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 The repository URL appears as svn://svn.FreeBSD.org/doc/ above, but is all lowercase here (and a couple other places). My personal preference would be all lowercase, which makes it hard for me to remember exactly when (if ever) the lowercase form of the domain/host name is actually supposed to be used. In any case, we should probably be consistent within the same document. -Ben > > 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 > > >