diff options
| author | William Victor Mote <vmote@apache.org> | 2003-05-03 06:16:35 +0000 |
|---|---|---|
| committer | William Victor Mote <vmote@apache.org> | 2003-05-03 06:16:35 +0000 |
| commit | 8bddae3718664de62149e6477f218db86beae38d (patch) | |
| tree | b30646edd750b6074e71adca61a2adc4411932e5 /src/documentation | |
| parent | 6f03aff6005294b52f41efb0fec24e0245c68026 (diff) | |
| download | xmlgraphics-fop-8bddae3718664de62149e6477f218db86beae38d.tar.gz xmlgraphics-fop-8bddae3718664de62149e6477f218db86beae38d.zip | |
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
Diffstat (limited to 'src/documentation')
| -rw-r--r-- | src/documentation/content/xdocs/book.xml | 2 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/compiling.xml | 31 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/download.xml | 3 |
3 files changed, 27 insertions, 9 deletions
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 @@ <menu label="Using FOP"> <menu-item label="Release Notes" href="relnotes.html"/> <menu-item label="Download" href="download.html"/> - <menu-item label="Compile" href="compiling.html"/> + <menu-item label="Build" href="compiling.html"/> <menu-item label="Configure" href="configuration.html"/> <menu-item label="Run" href="running.html"/> <menu-item label="Embed" href="embedding.html"/> diff --git a/src/documentation/content/xdocs/compiling.xml b/src/documentation/content/xdocs/compiling.xml index 51d7856e3..f4de7e4aa 100644 --- a/src/documentation/content/xdocs/compiling.xml +++ b/src/documentation/content/xdocs/compiling.xml @@ -4,13 +4,13 @@ <document> <header> - <title>Compiling FOP</title> + <title>FOP: Building from Source Code</title> </header> <body> <section> - <title>Do You Need To Compile?</title> + <title>Do You Need To Build?</title> <p>FOP distributions are either pre-compiled binary or source. -If you are using a binary distribution, it is already compiled and there is no need to compile it again. See the <link href="download.html">Download Instructions</link> for information about whether a binary or source distribution is best for your needs. +If you are using a binary distribution, it is already built and there is no need to build it again. See the <link href="download.html">Download Instructions</link> for information about whether a binary or source distribution is best for your needs. </p> </section> <section> @@ -29,18 +29,35 @@ You will only need to adjust the classpath if you build FOP in some other way. S </section> <section> <title>JAVA_HOME</title> - <p>Ant, which is used by the build script, requires that the enviroment variable JAVA_HOME point to your local JDK root directory. + <p>Ant, which is used by the build script, requires that the environment variable JAVA_HOME point to your local JDK root directory. This is true even if you use JDK 1.2 or above, which normally don't need this setting.</p> </section> </section> <section> <title>Run the "build" Script</title> <p>Build FOP by executing the "build" script, which is located in the FOP root directory. -The Windows batch file is build.bat, and the Unix shell script is build.sh.</p> +The Windows batch file is build.bat, and the Unix shell script is build.sh. +The examples below are for running the shell script, but except for the build file extension, the syntax is identical.</p> <p>The build script uses <link href="http://jakarta.apache.org/ant/">Ant</link>, 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.</p> - <p>A help screen is shown by calling "build usage".</p> +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:</p> + <source>build.sh -projecthelp</source> + <p>The most useful targets are:</p> + <ul> + <li><strong>package</strong>: Generates the jar files (default). This is the normal build that produces a jar file usable for running FOP.</li> + <li><strong>clean </strong>: 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.</li> + <li><strong>javadocs</strong>: Generates javadocs. This creates the FOP API documentation.</li> + </ul> + <p>To run the build:</p> + <source>build.sh [target ...]</source> + <p>For example to do a normal build for the package target (which is the default):</p> + <source>build.sh</source> + <p>OR</p> + <source>build.sh package</source> + <p>To clean the build directory first:</p> + <source>build.sh clean package</source> </section> <section> <title>Troubleshooting</title> 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 @@ <document> <header> - <title>Downloading FOP</title> + <title>FOP: Downloading A Distribution</title> </header> <body> <section id="dist-type"> @@ -14,6 +14,7 @@ However, a source distribution will be preferable if you fall into one of the fo <ul> <li>You wish to modify FOP.</li> <li>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.</li> + <li>You wish to build a local copy of the API documentation (javadocs).</li> </ul> </section> <section id="binary"> |