From owner-svn-doc-all@FreeBSD.ORG Sun May 20 20:07:11 2012 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id F0D45106566B; Sun, 20 May 2012 20:07:11 +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 DB1278FC18; Sun, 20 May 2012 20:07:11 +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 q4KK7B8G013354; Sun, 20 May 2012 20:07:11 GMT (envelope-from gjb@svn.freebsd.org) Received: (from gjb@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q4KK7BHY013352; Sun, 20 May 2012 20:07:11 GMT (envelope-from gjb@svn.freebsd.org) Message-Id: <201205202007.q4KK7BHY013352@svn.freebsd.org> From: Glen Barber Date: Sun, 20 May 2012 20:07:11 +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: r38856 - head/en_US.ISO8859-1/books/fdp-primer/the-website X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 20 May 2012 20:07:12 -0000 Author: gjb Date: Sun May 20 20:07:11 2012 New Revision: 38856 URL: http://svn.freebsd.org/changeset/doc/38856 Log: Update the FDP Primer "The Website" chapter for the CVS->SVN repository conversion: - Replace the 'the-website-csup' and 'the-website-cvsup' sections with a 'the-website-svn' section - Replace 'www/en' with 'en_US.ISO8859-1/htdocs' as the starting directory in the website build - Remove the documented CVSROOT environment variable - Update the WEB_LANG example to reflect the new repository layout - Add a 'tip' section, noting that if the initial 'svn checkout' command is not run as the root user, be sure that /usr/build is writable by the current user, or use a different checkout location Modified: head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml Modified: head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml Sun May 20 19:56:00 2012 (r38855) +++ head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.sgml Sun May 20 20:07:11 2012 (r38856) @@ -39,7 +39,7 @@ Use a disk with sufficient free space. You may need anything from 200 MB to over 500 MB, depending on the method you choose. This space will hold the SGML tools, a - subset of the CVS tree, temporary + subset of the svn tree, temporary build space and the installed web pages. @@ -52,205 +52,49 @@ &prompt.root; pkg_delete jade-1.1 - There are two methods to get the files required for the - website build: + + Using <command>svn</command> - - - Use csup to get a local copy of the - files from a CVSup server. This - is the easiest method, and does not require installation of - additional software. The supfile presented in the next - section will always checkout the latest version of the - required files. This is sufficient if you are simply - rebuilding the website and do not intend to commit any - changes. - - - - Use cvsup in cvs mode - to create and maintain a local - CVS repository with the required - files. This will require you to install a program like - net/cvsup-without-gui, - but it is a more flexible method if you need to have quick - access to different revisions of the doc/www files, revision - histories, or if you intend to commit changes to the central - &os; CVS repository. - - - - - Simple Method: Using <command>csup</command> - - csup is part of the base system and - already used extensively by most people for updating the - Ports Collection. The following sample supfile can be - used to obtain a checkout of the files required for the - website build: - - # -# This file checks out all collections required to rebuild -# the FreeBSD website -# -# Use the nearest CVSup mirror -# listed at http://www.freebsd.org/doc/handbook/mirrors.html. - -*default host=cvsup10.FreeBSD.org -*default base=/var/db -*default prefix=/usr/build -*default release=cvs tag=. -*default delete use-rel-suffix -*default compress - -# This will retrieve the entire doc branch of the FreeBSD repository. - -doc-all - -# This will retrieve the files required for the website - -www - -# This will retrieve some basic ports info required for the build - -ports-base - - You should, of course, change the default - host entry to a CVSup - mirror near your location, and the default - prefix entry to the location where you intend to - store the checked out files. Save this file as e.g. - doc-www-supfile, - and then execute the following command: - - &prompt.root; csup doc-www-supfile - - When this command finishes, you will find the directories - doc/, www/ and ports/ under the directory you - specified in default prefix (/usr/build - in our example). We will use this same directory for the - build process itself, so it would be better to use a - filesystem with sufficient free space. + svn is necessary to check + out the necessary files from the + doc/ Subversion repository. + svn can be installed with &man.pkg.add.1; + or from the &os; Ports Collection by running: + + &prompt.root; cd /usr/ports/devel/subversion +&prompt.root; make install clean + + To check out the full source files for the &os; website, + run: + + &prompt.root; svn checkout svn://svn.FreeBSD.org/doc/head/ /usr/build + + + If svn is not run as the + root, be sure /usr/build has the proper + permissions for the current user. If changing the + permissions is not possible, use a different target + directory for the website files. + + + When svn finishes, the current version + of the &os; website will exist within /usr/build. If a different + target directory was used, replace /usr/build appropriately + throughout the remainder of this document. That's it! You can now proceed with the website build. - - - Advanced Method: Maintaining a Local - <application>CVS</application> <literal>doc/www</literal> - Repository - - This method will give you more advanced options, but will - require you to install the - net/cvsup-without-gui port or - package. - - - The net/cvsup-without-gui port has - a build dependency on lang/ezm3, a Modula 3 - compiler. This compiler takes quite some time to build, - and since most people will not need it for anything else, it - is perhaps best to use a package to install - CVSup. - - - The CVSup utility has a special - cvs mode that allows the retrieval of the - ,v files that make up a - CVS repository. This function is - not currently available in csup. - For detailed information on CVSup, - please read the CVSup - introduction in the &os; Handbook. - - The supfile shown below will fetch the cvs collections - required for the website build, and create a local - CVS repository: - - # -# This file will create a local CVS repository -# with the collections required for a complete -# FreeBSD website rebuild. It should be used with -# cvsup *only* (csup will not work) - -*default host=cvsup10.FreeBSD.org -*default base=/var/db -*default prefix=/usr/dcvs -*default release=cvs -*default delete use-rel-suffix -*default compress - -# The following collections are needed -# for the website build - -ports-base -doc-all -www - -# These collections are needed -# for CVS functionality - -cvsroot-common -cvsroot-ports -cvsroot-doc - - You should, of course, change the default - host entry to a CVSup - mirror near your location, and the default - prefix entry to the location where you intend to - store the repository files. Save this file as e.g. - doc-www-cvsfile, - and then execute the following command: - - &prompt.root; cvsup doc-www-cvsfile - - It is also advisable to set the CVSROOT - environment variable in your shell's startup files. For - example, use the following entry in - ~/.cshrc: - - setenv CVSROOT /usr/dcvs - - If you set this variable, you may omit the - argument (shown below) when performing - repository operations using cvs. - - Currently, you will need more than 400 MB of free - space to host the repository files. An additional 200 MB - will be needed for the temporary build space. Once - cvsup completes, you are ready to check out - the files to your build directory: - - &prompt.root; mkdir /usr/build -&prompt.root; cd /usr/build -&prompt.root; cvs /usr/dcvs co doc www ports - - The above command is consistent with the way - csup checks out the files from the - CVSup servers. When it completes, - you will have a build directory with similar contents to the - one used in the simple csup - method. - - You can continue to use cvsup as shown - above, to update your local CVS - repository on a regular basis. After the initial somewhat - lengthy download, regular updates will only take a few - minutes. - Build the Web Pages from Scratch - Having completed either of the two methods, you will be - ready to start the website build. In our example, the build + Having completed the necessary steps to obtain the website + source files, the website can be built. In our example, the build directory is /usr/build and all the required files are already in place. @@ -264,11 +108,11 @@ cvsroot-doc The website build starts from the www/en directory by executing + class="directory">en_US.ISO8859-1/htdocs directory by executing the &man.make.1; all target, to create the web pages. - &prompt.root; cd www/en + &prompt.root; cd en_US.ISO8859-1/htdocs &prompt.root; make all @@ -280,10 +124,10 @@ cvsroot-doc If you have moved out of the en directory, change back to + class="directory">en_US.ISO8859-1/htdocs directory, change back to it. - &prompt.root; cd /usr/build/www/en + &prompt.root; cd /usr/build/en_US.ISO8859-1/htdocs @@ -316,25 +160,6 @@ cvsroot-doc - CVSROOT - - - Location of the CVS tree. We suggest you set this - variable, if you use the CVSup - method: - - &prompt.root; CVSROOT=/usr/dcvs; export CVSROOT - - CVSROOT is an environment variable. - You must set it on the command line or in your dot files - (e.g., ~/.profile). The exact syntax - will differ depending on your shell (the above example is - for bash and bash-like - shells). - - - - ENGLISH_ONLY @@ -359,10 +184,10 @@ cvsroot-doc If set and not empty, the Makefiles will build and install only the HTML pages from the www directory. All - documents from the doc - directory (Handbook, FAQ, Tutorials) will be ignored. + class="directory">en_US.ISO8859-1/htdocs directory. + All other directories within en_US.ISO8859-1 + (Handbook, FAQ, Tutorials) will be ignored. E.g.: &prompt.root; make WEB_ONLY=YES all install @@ -375,11 +200,11 @@ cvsroot-doc If set, the Makefiles will build and install only for the languages specified by this variable inside the - www directory. All + /usr/build directory. All other languages except English will be ignored. E.g.: - &prompt.root; make WEB_LANG="el es hu nl" all install + &prompt.root; make WEB_LANG="el_GR.ISO8859-7 es_ES.ISO8859-1 hu_HU.ISO8859-2 nl_NL.ISO8859-1" all install