You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2022/02/01 07:35:31 UTC

[logging-log4j2] branch release-2.x updated: Update build instructions

This is an automated email from the ASF dual-hosted git repository.

mattsicker pushed a commit to branch release-2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/release-2.x by this push:
     new c7d648b  Update build instructions
c7d648b is described below

commit c7d648bc69a59a704d4340c2b1fe5eb027267846
Author: Matt Sicker <ma...@apache.org>
AuthorDate: Tue Feb 1 01:34:54 2022 -0600

    Update build instructions
---
 BUILDING.md | 22 +++-------------------
 1 file changed, 3 insertions(+), 19 deletions(-)

diff --git a/BUILDING.md b/BUILDING.md
index 11a544e..09b5708 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -14,12 +14,11 @@
  See the License for the specific language governing permissions and
  limitations under the License.
 -->
-# Building Log4j 2
+# Building Log4j 2.x
 
-To build Log4j 2, you need a JDK implementation version 1.7 or greater, JDK
-version 9, and Apache Maven 3.x.
+To build Log4j 2.x, you need Java 8 and Java 11 compilers, and Apache Maven 3.x.
 
-Log4j 2.x uses the Java 9 compiler in addition to
+Log4j 2.x uses the Java 11 compiler in addition to
 the Java version installed in the path. This is accomplished by using Maven's toolchains support.
 Log4j 2 provides sample toolchains XML files in the root folder. This may be used by
 modifying it and installing the file as toolchains.xml in the .m2 folder or by using the
@@ -35,10 +34,6 @@ To perform the license release audit, a.k.a. "RAT check", run.
 
     mvn apache-rat:check
 
-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
@@ -51,10 +46,6 @@ Once install is run, you can run the Clirr check on the API and 1.2 API modules:
 
 Next, to build the site:
 
-If Java 8 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:
@@ -68,10 +59,3 @@ On UNIX, use a local staging directory, for example:
 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 .