diff --git a/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml b/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
index cf948a087f..6616d9591b 100644
--- a/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
+++ b/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
@@ -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;.
+ Update the local working copy:
- 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
+ &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.