From owner-svn-doc-head@FreeBSD.ORG Mon Jul 22 21:00:04 2013 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id 1172E5D8; Mon, 22 Jul 2013 21:00:04 +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 E7C932487; Mon, 22 Jul 2013 21:00:03 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r6ML03aP016810; Mon, 22 Jul 2013 21:00:03 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r6ML03ib016809; Mon, 22 Jul 2013 21:00:03 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201307222100.r6ML03ib016809@svn.freebsd.org> From: Warren Block Date: Mon, 22 Jul 2013 21:00:03 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42383 - 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:00:04 -0000 Author: wblock Date: Mon Jul 22 21:00:03 2013 New Revision: 42383 URL: http://svnweb.freebsd.org/changeset/doc/42383 Log: Simplify the quick start a bit more by referring to later sections. Use ~/doc for the working copy to be consistent with later sections. 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 20:27:54 2013 (r42382) +++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Mon Jul 22 21:00:03 2013 (r42383) @@ -163,21 +163,14 @@ Install a local working copy of the documentation - from a mirror of the &os; repository. If /usr/doc already exists, move - or delete it first to prevent file conflicts. + from a mirror of the &os; repository (see ) in ~/doc. &prompt.user; svn checkout https://svn0.us-west.FreeBSD.org/doc/head /usr/doc - For the fastest download, pick the nearest mirror from - the list of Subversion - mirror sites. - The editor to be used should be configured as - follows: + Configure the text editor: @@ -195,22 +188,22 @@ - Some specific editor configurations - are listed in . + Specific editor configurations + are listed in . - Run svn up to update the local - working copy. Edit the documentation files that need - changes. Before making major changes to a file, ask for - input on the &a.doc;. - - To learn which tags and entities are needed to achieve - the desired formatting, compare some text in the - HTML formatted version of the document - to the text, tags, and entities in the - XML file. References to the commonly - used tags and entities can be found 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 . @@ -230,25 +223,24 @@ Always build-test changes before - submitting them. By default, typing + submitting them. Running make in the top-level directory of - the type of documentation being edited will generate that + 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. This step is necessary to make sure that edits - do not break the build. + directory. - After successfully completing the previous steps, - generate a diff file of the changes: + 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 name that describes the contents. + Give the diff file a descriptive name. In the example above, changes have been made to the bsdinstall portion of the Handbook. @@ -258,24 +250,15 @@ Submit the diff file using the web-based Problem Report system or with &man.send-pr.1;. If using - the web form, input a synopsis of [patch] + the web form, enter a synopsis of [patch] short description of problem. Select the category docs and the class - doc-bug. The body of the message - should contain a short description of the edits and any - important discussion points. Use the + 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. - - Remember that the FDP is comprised - of volunteers who review edits in their spare time and who - live in different time zones around the globe. It can - take some time to review changes. If a response is not - received in a reasonable amount of time, send a follow-up - email to the &a.doc; and ask if anyone has had a chance to - review the patch or if additional information is - required.