From owner-svn-doc-all@FreeBSD.ORG Wed Jun 26 00:36:59 2013 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id B38CD674; Wed, 26 Jun 2013 00:36:59 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) by mx1.freebsd.org (Postfix) with ESMTP id 958991E4C; Wed, 26 Jun 2013 00:36:59 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r5Q0axwZ015673; Wed, 26 Jun 2013 00:36:59 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r5Q0axMs015672; Wed, 26 Jun 2013 00:36:59 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201306260036.r5Q0axMs015672@svn.freebsd.org> From: Warren Block Date: Wed, 26 Jun 2013 00:36:59 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42054 - head/en_US.ISO8859-1/books/fdp-primer/the-website X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.14 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: Wed, 26 Jun 2013 00:36:59 -0000 Author: wblock Date: Wed Jun 26 00:36:59 2013 New Revision: 42054 URL: http://svnweb.freebsd.org/changeset/doc/42054 Log: Whitespace-only fixes. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Wed Jun 26 00:24:46 2013 (r42053) +++ head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Wed Jun 26 00:36:59 2013 (r42054) @@ -39,24 +39,23 @@ Use a disk with sufficient free space. A full copy of the documentation and web site files takes over 700 MB. - Allowing a full gigabyte provides some breathing room. - This space will hold the XML tools, the - documentation tree, temporary + Allowing a full gigabyte provides some breathing room. This + space will hold the XML tools, the documentation tree, temporary build space and the installed web pages. Make sure the documentation ports are updated to the - latest version. See the - Handbook section on ports - for more information. + latest version. See + the + Handbook section on ports for more + information. Using <command>svn</command> - svn is needed to check - out the documentation and web site files from the + svn is needed to check out the + documentation and web site files from the doc Subversion repository. svn can be installed with &man.pkg.add.1; or from the &os; Ports Collection by running: @@ -64,80 +63,79 @@ &prompt.root; cd /usr/ports/devel/subversion &prompt.root; make install clean - To check out the source files for the &os; web site and the rest of the documentation, - run: + To check out the source files for the &os; web site and + the rest of the documentation, run: &prompt.user; svn checkout https://svn0.us-east.FreeBSD.org/doc/head/ ~/doc svn0.us-east.FreeBSD.org - is a public SVN server. - Select the closest mirror and verify the mirror server - certificate from the list of Subversion + is a public SVN server. Select the closest + mirror and verify the mirror server certificate from the list + of + Subversion mirror sites. - After the checkout completes, the current version - of the &os; documentation, including the web site files, will be present in ~/doc. + After the checkout completes, the current version of the + &os; documentation, including the web site files, will be + present in + ~/doc. Build the Web Pages - Having obtained the documentation and web site - source files, the web site can be built. In this example, the - build directory is Having obtained the documentation and web site source files, + the web site can be built. In this example, the build directory + is ~/doc and all the required files are already in place. - The web site is built from the en_US.ISO8859-1/htdocs - subdirectory of the document tree directory, - ~/doc in this example. - Change to the build directory and start the build by executing make all. + The web site is built from the + en_US.ISO8859-1/htdocs + subdirectory of the document tree directory, + ~/doc in this example. + Change to the build directory and start the build by executing + make all. &prompt.user; cd ~/doc/en_US.ISO8859-1/htdocs &prompt.user; make all - The web site build uses the INDEX from the Ports Collection - and may fail if that file or /usr/ports - is not present. The simplest approach is to install the - Ports Collection. + The web site build uses the INDEX + from the Ports Collection and may fail if that file or + /usr/ports is not + present. The simplest approach is to install the Ports + Collection. Install the Web Pages - Run make install, - setting DESTDIR to - the target directory for the web site files. - The files will be installed in $DESTDIR/data, - which is expected to be the web server's document - root. - - This installation is run as the - root user because the permissions on - the web server directory will not allow files to be - installed by an unprivileged user. In this example, the web site - files were built by user jru in their - home directory, /usr/home/jru/doc. + Run make install, setting + DESTDIR to the target directory for the web + site files. The files will be installed in + $DESTDIR/data, which is + expected to be the web server's document root. + + This installation is run as the root + user because the permissions on the web server directory will + not allow files to be installed by an unprivileged user. In + this example, the web site files were built by user + jru in their home directory, /usr/home/jru/doc. &prompt.root; cd /home/jru/doc/en_US.ISO8859-1/htdocs &prompt.root; env DESTDIR=/usr/local/www make install - The install process will not delete any old or outdated files - that existed previously in the same directory. - If a new copy of the site is built and - installed every day, this command will - find and delete all files that have not been updated in - three days. + The install process will not delete any old or outdated + files that existed previously in the same directory. If a new + copy of the site is built and installed every day, this command + will find and delete all files that have not been updated in + three days. &prompt.root; find /usr/local/www 3 @@ -151,15 +149,14 @@ If set and not empty, only the English documents will - be built or installed. All translations will - be ignored. E.g.: + be built or installed. All translations will be ignored. + E.g.: &prompt.root; make ENGLISH_ONLY=YES all install - To unset the variable - and build all pages, - including translations, set - ENGLISH_ONLY to an empty value: + To unset the variable and build all pages, including + translations, set ENGLISH_ONLY to an + empty value: &prompt.root; make ENGLISH_ONLY="" all install clean @@ -172,10 +169,10 @@ If set and not empty, only the HTML pages from the en_US.ISO8859-1/htdocs - directory will be built or installed. All other directories within en_US.ISO8859-1 - (Handbook, FAQ, Tutorials) will be ignored. - E.g.: + directory will be built or installed. All other + directories within + en_US.ISO8859-1 + (Handbook, FAQ, Tutorials) will be ignored. E.g.: &prompt.root; make WEB_ONLY=YES all install @@ -185,9 +182,8 @@ WEB_LANG - If set, build or install only for - the languages specified by this variable inside the - If set, build or install only for the languages + specified by this variable inside the ~/doc directory. All other languages except English will be ignored. E.g.: @@ -198,9 +194,8 @@ WEB_ONLY, WEB_LANG, - and ENGLISH_ONLY - are &man.make.1; variables and - can be set in /etc/make.conf, + and ENGLISH_ONLY are &man.make.1; variables + and can be set in /etc/make.conf, Makefile.inc, as environment variables on the command line, or in dot files.