From owner-svn-doc-head@FreeBSD.ORG Mon Jul 22 21:08:57 2013 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id 574927D7; Mon, 22 Jul 2013 21:08:57 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 45CE2251E; Mon, 22 Jul 2013 21:08:57 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r6ML8vLY019868; Mon, 22 Jul 2013 21:08:57 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r6ML8vt9019867; Mon, 22 Jul 2013 21:08:57 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201307222108.r6ML8vt9019867@svn.freebsd.org> From: Warren Block Date: Mon, 22 Jul 2013 21:08:57 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42384 - head/en_US.ISO8859-1/books/fdp-primer/overview X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.14 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, 22 Jul 2013 21:08:57 -0000 Author: wblock Date: Mon Jul 22 21:08:56 2013 New Revision: 42384 URL: http://svnweb.freebsd.org/changeset/doc/42384 Log: Whitespace-only fixes. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Mon Jul 22 21:00:03 2013 (r42383) +++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Mon Jul 22 21:08:56 2013 (r42384) @@ -125,22 +125,21 @@ svn log. Commit messages are also archived at . - Many people have written tutorials or how-to - articles about &os;. Some are stored as part of the - FDP files. In other cases, the author has - decided to keep the documentation separate. The - FDP endeavors to provide links to as much of - this external documentation as possible. + Many people have written tutorials or how-to articles about + &os;. Some are stored as part of the FDP + files. In other cases, the author has decided to keep the + documentation separate. The FDP endeavors to + provide links to as much of this external documentation as + possible. Quick Start - Some preparatory steps must be taken before - editing the &os; documentation. New - contributors will interact with other members of the &os; - Documentation Team, which can assist in learning to use - XML and the suggestions in + Some preparatory steps must be taken before editing the &os; + documentation. New contributors will interact with other + members of the &os; Documentation Team, which can assist in + learning to use XML and the suggestions in . If a new user contributes regularly, a Documentation Team member may be assigned as a mentor to guide the user through the process from @@ -148,8 +147,8 @@ - Subscribe to the &a.doc;. Some mailing list - members also interact on the #bsddocs + Subscribe to the &a.doc;. Some mailing list members + also interact on the #bsddocs IRC channel on EFnet. @@ -163,103 +162,101 @@ Install a local working copy of the documentation - from a mirror of the &os; repository (see ) in ~/doc. + from a mirror of the &os; repository (see + ) in + ~/doc. &prompt.user; svn checkout https://svn0.us-west.FreeBSD.org/doc/head /usr/doc + + + + Configure the text editor: + + + + Word wrap set to 70 characters. + + + + Tab stops set to 2. + + + + Replace each group of 8 leading spaces with a + single tab. + + - + Specific editor configurations are listed in + . + + + + Update the local working copy: - - Configure the text editor: + &prompt.user; svn up ~/doc + + + + Edit the documentation files that require changes. If a + file needs major changes, consult the &a.doc; for + input. + + References to tag and entity usage can be found in + and + . + + + + After editing, check for problems by running: - - - Word wrap set to 70 characters. - - - - Tab stops set to 2. - - - - Replace each group of 8 leading spaces with a - single tab. - - - - - Specific editor configurations - are listed in . - - - - Update the local working copy: - - &prompt.user; svn up ~/doc - - - - Edit the documentation files that require - changes. If a file needs major changes, consult the - &a.doc; for input. - - References to tag and entity usage can be found in - and - . - - - - After editing, check for problems by - running: - - &prompt.user; igor -R filename.xml | less -RS - - Review the output and edit the file to fix any - problems shown, then rerun the command to find any - remaining problems. Repeat until all of the errors that - are fixable are resolved. If an error seems unsolvable, - ask for assistance on the &a.doc;. - - - - Always build-test changes before - submitting them. Running - make in the top-level directory of - the documentation being edited will generate that - documentation in split HTML format. For example, to build - the English version of the Handbook in - HTML, type make in - the en_US.ISO8859-1/books/handbook/ - directory. - - - - When changes are complete and tested, - generate a diff file: + &prompt.user; igor -R filename.xml | less -RS - &prompt.user; cd /usr/doc + Review the output and edit the file to fix any problems + shown, then rerun the command to find any remaining + problems. Repeat until all of the errors that are fixable + are resolved. If an error seems unsolvable, ask for + assistance on the &a.doc;. + + + + Always build-test changes before + submitting them. Running make in the + top-level directory of the documentation being edited will + generate that documentation in split HTML format. For + example, to build the English version of the Handbook in + HTML, type make in the + en_US.ISO8859-1/books/handbook/ + directory. + + + + When changes are complete and tested, generate a + diff file: + + &prompt.user; cd /usr/doc &prompt.user; svn diff > bsdinstall.diff.txt - Give the diff file a descriptive name. - In the example above, changes have been made to the - bsdinstall portion - of the Handbook. - - - - Submit the diff file using the web-based Problem - Report system or with &man.send-pr.1;. If using - the web form, enter a synopsis of [patch] - short description of - problem. Select the category - docs and the class - doc-bug. In the body of the message, - enter a short description of the changes and any - important details about them. Use the - [ Browse... ] button to - attach the .diff.txt. - - - - + Give the diff file a descriptive name. In the example + above, changes have been made to the + bsdinstall portion of + the Handbook. + + + + Submit the diff file using the web-based + Problem + Report system or with &man.send-pr.1;. If using + the web form, enter a synopsis of + [patch] short description of + problem. Select the category + docs and the class + doc-bug. In the body of the message, + enter a short description of the changes and any important + details about them. Use the + [ Browse... ] button to + attach the .diff.txt. + + + +