From: William Victor Mote
Date: Sat, 3 May 2003 06:16:35 +0000 (+0000)
Subject: Add content for the build process.
X-Git-Tag: Root_Temp_KnuthStylePageBreaking~1492
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=8bddae3718664de62149e6477f218db86beae38d;p=xmlgraphics-fop.git
Add content for the build process.
Change terminology from "compile" to "build".
Add building javadocs as a reason to download source.
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196393 13f79535-47bb-0310-9956-ffa450edef68
---
diff --git a/src/documentation/content/xdocs/book.xml b/src/documentation/content/xdocs/book.xml
index f653a6e69..d73690715 100644
--- a/src/documentation/content/xdocs/book.xml
+++ b/src/documentation/content/xdocs/book.xml
@@ -23,7 +23,7 @@
The build script uses Ant, a popular java-based build tool.
The file build.xml in the FOP root directory is the blueprint that Ant uses for the build.
-Consult its contents for detailed information on the build process and the various build targets.
-
A help screen is shown by calling "build usage".
+It contains information for numerous build targets, many of which are building blocks to more useful target, and others which are primarily used by the FOP developers.
+You may benefit from looking through this file to learn more about the various build targets.
+To obtain a complete list of useful build targets:
+
+
The most useful targets are:
+
+
package: Generates the jar files (default). This is the normal build that produces a jar file usable for running FOP.
+
clean : Cleans the build directory. This is useful for making sure that any build errors are cleaned up before starting a new build. It should not ordinarily be needed, but may be helpful if you are having problems with the build process itself.
+
javadocs: Generates javadocs. This creates the FOP API documentation.
+
+
To run the build:
+
+
For example to do a normal build for the package target (which is the default):
+
+
OR
+
+
To clean the build directory first:
+
Troubleshooting
diff --git a/src/documentation/content/xdocs/download.xml b/src/documentation/content/xdocs/download.xml
index 18c13f2b6..765155e75 100644
--- a/src/documentation/content/xdocs/download.xml
+++ b/src/documentation/content/xdocs/download.xml
@@ -4,7 +4,7 @@
- Downloading FOP
+ FOP: Downloading A Distribution
@@ -14,6 +14,7 @@ However, a source distribution will be preferable if you fall into one of the fo
You wish to modify FOP.
You wish to use a version more recent than the latest release. For example, if you have read on the user mailing list that a bug has been fixed or a feature added that you are eager to try, you might download a source distribution from the CVS repository so that you don't have to wait for the next release.
+
You wish to build a local copy of the API documentation (javadocs).