You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xmlgraphics.apache.org by ss...@apache.org on 2023/02/03 09:14:20 UTC
[xmlgraphics-website] branch master updated: Switch docs to mvn
This is an automated email from the ASF dual-hosted git repository.
ssteiner pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/xmlgraphics-website.git
The following commit(s) were added to refs/heads/master by this push:
new 853fd12b Switch docs to mvn
853fd12b is described below
commit 853fd12bcc8400d738c6ebc9d35a966e64bcf506
Author: ssteiner <ss...@apache.org>
AuthorDate: Fri Feb 3 09:14:08 2023 +0000
Switch docs to mvn
---
content/fop/dev/tools.mdtext | 2 +-
content/fop/trunk/compiling.mdtext | 39 ++++++++++++++------------------------
2 files changed, 15 insertions(+), 26 deletions(-)
diff --git a/content/fop/dev/tools.mdtext b/content/fop/dev/tools.mdtext
index 88f792c9..9b1d2c4c 100644
--- a/content/fop/dev/tools.mdtext
+++ b/content/fop/dev/tools.mdtext
@@ -14,7 +14,7 @@ Here is a (probably not comprehensive) list of tools you will need to be a succe
- A Subversion client (see [Subversion](#svn)).
-- Ant (see [Building FOP](../trunk/compiling.html)).
+- Maven (see [Building FOP](../trunk/compiling.html)).
- checkstyle (see [Checkstyle](conventions.html#java-checkstyle) on the conventions page).
diff --git a/content/fop/trunk/compiling.mdtext b/content/fop/trunk/compiling.mdtext
index ddd47e79..38fec491 100644
--- a/content/fop/trunk/compiling.mdtext
+++ b/content/fop/trunk/compiling.mdtext
@@ -15,60 +15,49 @@ Building FOP requires a minimum Java Development Kit (JDK/SDK) of {{ fop_minimal
### CLASSPATH { #env-classpath}
-There is generally no need to setup a classpath. All libraries needed to compile FOP are included in the source distribution and are referenced by the build script. You will only need to adjust the classpath if you build FOP in some other way. See the build script build.xml for details.
+There is generally no need to setup a classpath. All libraries needed to compile FOP are included in the source distribution and are referenced by the build script. You will only need to adjust the classpath if you build FOP in some other way. See the build script pom.xml for details.
### JAVA_HOME { #env-java-home}
-The build script uses [Apache Ant](http://ant.apache.org/), a popular Java-based build tool, which usually requires that the environment variable JAVA_HOME point to your local JDK root directory. This is true even if you use JDK 1.5 or above, which normally does not need this setting.
+The build script uses [Apache Maven](https://maven.apache.org/), a popular Java-based build tool, which usually requires that the environment variable JAVA_HOME point to your local JDK root directory. This is true even if you use JDK 1.5 or above, which normally does not need this setting.
-### Apache Ant { #env-ant}
+### Apache Maven { #env-maven}
- [Apache Ant](http://ant.apache.org/) (Version 1.7 or later) must be installed in order to build FOP. Following best practices we don't include Ant with FOP anymore. You can find the [instructions to install Ant in the Ant manual](http://ant.apache.org/manual/) on the web.
+ [Apache Maven](https://maven.apache.org/) (Version 3.6 or later) must be installed in order to build FOP. You can find the [instructions to install Maven in the Maven manual](https://maven.apache.org/install.html) on the web.
## Run the Build Script { #build-script}
-Change to the FOP root directory and build FOP by executing the build script (build.xml) using the "ant" command.
+Change to the FOP root directory and build FOP by executing the build script (pom.xml) using the "mvn" command.
-<note>The "ant" command is only available on your system if you've properly [installed Apache Ant](http://ant.apache.org/manual/) and added Ant's location to the PATH environment variable.</note>
+<note>The "mvn" command is only available on your system if you've properly [installed Apache Maven](https://maven.apache.org/install.html) and added Maven's location to the PATH environment variable.</note>
-The file build.xml in the FOP root directory is the blueprint that Ant uses for the build. 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:
-
- ant -projecthelp
+The file pom.xml in the FOP root directory is the blueprint that Maven uses for the build.
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.
+- **install**: 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**: Creates the FOP API documentation.
+- **javadoc:javadoc**: Creates the FOP API documentation.
To run the build:
- ant [target ...]
-
-For example to do a normal build for the "all" target (which is the default):
-
- ant
+ mvn [target ...]
-OR
+For example to do a normal build for the "install" target (which is the default):
- ant all
+ mvn clean install -DskipTests
-To clean the build directory first:
-
- ant clean all
-
-<note>If you want to shorten the build time you can just call the "package" target which doesn't perform any automated tests during the build.</note>
+<note>If you want to shorten the build time you can just add the "-DskipTests" argument which doesn't perform any automated tests during the build.</note>
## Troubleshooting { #problems}
If you have problems building FOP, please try the following:
-
- Run the build with the target of "clean", then rerun the build.
-- Delete the build directory completely, then rerun the build.
+- Delete the target directory completely, then rerun the build.
- Make sure you do not have a non-FOP version of xerces.jar, xalan.jar, batik.jar, or another dependency product somewhere in your CLASSPATH.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlgraphics.apache.org
For additional commands, e-mail: commits-help@xmlgraphics.apache.org