Repository: logging-log4j2 Updated Branches: refs/heads/master 8c4c88b92 -> 23da1c37f
Convert BUILDING to markdown Less file formats needed now! Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/23da1c37 Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/23da1c37 Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/23da1c37 Branch: refs/heads/master Commit: 23da1c37f3c81c92127f8830857f82959619a982 Parents: 8c4c88b Author: Matt Sicker <[email protected]> Authored: Sun Jan 15 18:21:04 2017 -0600 Committer: Matt Sicker <[email protected]> Committed: Sun Jan 15 18:21:04 2017 -0600 ---------------------------------------------------------------------- BUILDING.adoc | 70 ------------------------------------------------------ BUILDING.md | 52 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 70 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/23da1c37/BUILDING.adoc ---------------------------------------------------------------------- diff --git a/BUILDING.adoc b/BUILDING.adoc deleted file mode 100644 index 8c42efa..0000000 --- a/BUILDING.adoc +++ /dev/null @@ -1,70 +0,0 @@ -= Building Log4j 2 - -To build Log4j 2, you need a JDK implementation version 1.7 or greater, and Apache Maven. -Note that building the site requires Maven 3.0.5, while everything else works -fine with any version of Maven 3. - -To perform the license release audit, a.k.a. "RAT check", run. - ----- -mvn apache-rat:check ----- - -To perform a Clirr check on the API module, run - ----- -mvn clirr:check -pl log4j-api ----- - -To build the site with Java 7, make sure you give Maven enough memory using -`MAVEN_OPTS` with options appropriate for your JVM. Alternatively, you can -build with Java 8 and not deal with `MAVEN_OPTS`. - -To install the jars in your local Maven repository, from a command line, run: - ----- -mvn clean install ----- - -Once install is run, you can run the Clirr check on the 1.2 API module: - ----- -mvn clirr:check -pl log4j-1.2-api ----- - -Next, to build the site: - -If Java 7 runs out of memory building the site, you will need: - ----- -set MAVEN_OPTS=-Xmx2000m -XX:MaxPermSize=384m - -mvn site ----- - -On Windows, use a local staging directory, for example: - ----- -mvn site:stage-deploy -DstagingSiteURL=file:///%HOME%/log4j ----- - -On UNIX, use a local staging directory, for example: - ----- -mvn site:stage-deploy -DstagingSiteURL=file:///$HOME/log4j ----- - -To test, run: - ----- -mvn clean install ----- - -== Testing in Docker - -In order to run a clean test using the minimum version of the JDK along with a -proper Linux environment, run: - ----- -docker build . ----- http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/23da1c37/BUILDING.md ---------------------------------------------------------------------- diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 0000000..2a577c4 --- /dev/null +++ b/BUILDING.md @@ -0,0 +1,52 @@ +# Building Log4j 2 + +To build Log4j 2, you need a JDK implementation version 1.7 or greater, and Apache Maven. +Note that building the site requires Maven 3.0.5, while everything else works +fine with any version of Maven 3. + +To perform the license release audit, a.k.a. "RAT check", run. + + mvn apache-rat:check + +To perform a Clirr check on the API module, run + + mvn clirr:check -pl log4j-api + +To build the site with Java 7, make sure you give Maven enough memory using +`MAVEN_OPTS` with options appropriate for your JVM. Alternatively, you can +build with Java 8 and not deal with `MAVEN_OPTS`. + +To install the jars in your local Maven repository, from a command line, run: + + mvn clean install + +Once install is run, you can run the Clirr check on the 1.2 API module: + + mvn clirr:check -pl log4j-1.2-api + +Next, to build the site: + +If Java 7 runs out of memory building the site, you will need: + + set MAVEN_OPTS=-Xmx2000m -XX:MaxPermSize=384m + + mvn site + +On Windows, use a local staging directory, for example: + + mvn site:stage-deploy -DstagingSiteURL=file:///%HOME%/log4j + +On UNIX, use a local staging directory, for example: + + mvn site:stage-deploy -DstagingSiteURL=file:///$HOME/log4j + +To test, run: + + mvn clean install + +## Testing in Docker + +In order to run a clean test using the minimum version of the JDK along with a +proper Linux environment, run: + + docker build .
