This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/master by this push:
new 116d5ee24e LOG4J2-3573 Removed build page in favor of a single build
instructions file.
116d5ee24e is described below
commit 116d5ee24e35ce7b42e9afe9ec193e15749d6a2b
Author: Volkan Yazıcı <[email protected]>
AuthorDate: Thu Aug 18 14:24:34 2022 +0200
LOG4J2-3573 Removed build page in favor of a single build instructions file.
---
BUILDING.md | 42 ++++++++++++++------------
README.md | 31 ++++++++++++++------
src/changes/changes.xml | 3 ++
src/site/asciidoc/build.adoc | 70 --------------------------------------------
src/site/site.xml | 1 -
5 files changed, 48 insertions(+), 99 deletions(-)
diff --git a/BUILDING.md b/BUILDING.md
index 6c6201c41c..ccafef3fa6 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -14,36 +14,40 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-# Building Log4j 3.x
-To build Log4j 3.x, you need a JDK implementation version 11 (at least version
11.0.13 if building on macOS) or greater and Apache Maven 3.x.
+# Requirements
-To perform the license release audit, a.k.a. "RAT check", run.
+* JDK 11
+* Apache Maven 3.x
+* A modern Linux, OSX, or Windows host
- mvn apache-rat:check
+<a name="building"></a>
+# Building the sources
-To install the jars in your local Maven repository, from a command line, run:
+You can build and verify the sources as follows:
- mvn clean install
+ ./mvnw verify
-Once install is run, you can run the Clirr check on the API and 1.2 API
modules:
+`verify` goal runs validation and test steps next to building (i.e.,
compiling) the sources.
+To speed up the build, you can skip verification:
- mvn clirr:check -pl log4j-api
+ ./mvwn -DskipTests package
- mvn clirr:check -pl log4j-1.2-api
+If you want to install generated artifacts to your local Maven repository,
replace above `verify` and/or `package` goals with `install`.
-Next, to build the site:
+<a name="dns"></a>
+## DNS lookups in tests
- mvn site
+Note that if your `/etc/hosts` file does not include an entry for your
computer's hostname, then
+many unit tests may execute slow due to DNS lookups to translate your hostname
to an IP address in
+[`InetAddress.getLocalHost()`](http://docs.oracle.com/javase/7/docs/api/java/net/InetAddress.html#getLocalHost()).
+To remedy this, you can execute the following:
-On Windows, use a local staging directory, for example:
+ printf '127.0.0.1 %s\n::1 %s\n' `hostname` `hostname` | sudo tee -a
/etc/hosts
- mvn site:stage-deploy -DstagingSiteURL=file:///%HOMEDRIVE%%HOMEPATH%/log4j
+<a name="website"></a>
+# Building the website and manual
-On UNIX, use a local staging directory, for example:
+You can build the website and manual as follows:
- mvn site:stage-deploy -DstagingSiteURL=file:///$HOME/log4j
-
-To test, run:
-
- mvn clean install
+ ./mvnw --non-recursive -Dmaven.doap.skip -DskipTests site
diff --git a/README.md b/README.md
index e781f30ef1..4aa65ab6bf 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
# [Apache Log4j 3.x](https://logging.apache.org/log4j/2.x/)
Apache Log4j 3.x is an upgrade to Log4j that provides significant improvements
over its predecessor, Log4j 1.x,
@@ -80,12 +97,12 @@ Apache Log4j 3.x is distributed under the [Apache License,
version 2.0](http://w
[How to download Log4j](http://logging.apache.org/log4j/2.x/download.html),
and [how to use it from Maven, Ivy and
Gradle](http://logging.apache.org/log4j/2.x/maven-artifacts.html).
-You can access the latest development snapshot by using the Maven repository
`https://repository.apache.org/snapshots`,
+You can access the latest development snapshot by using the Maven repository
`https://repository.apache.org/snapshots`,
see [Snapshot
builds](https://logging.apache.org/log4j/2.x/maven-artifacts.html#Snapshot_builds).
## Issue Tracking
-Issues, bugs, and feature requests should be submitted to the
+Issues, bugs, and feature requests should be submitted to the
[JIRA issue tracking system for this
project](https://issues.apache.org/jira/browse/LOG4J2).
Pull requests on GitHub are welcome, but please open a ticket in the JIRA
issue tracker first, and mention the
@@ -93,13 +110,9 @@ JIRA issue in the Pull Request.
## Building From Source
-Log4j 3.x requires Java 11 (at least version 11.0.13 when building on macOS)
and Apache Maven 3.x. To build from source and install to your local Maven
repository, execute the following:
-
-```sh
-mvn install
-```
+See [the detailed build instructions](BUILDING.md) on how to build to the
project and website from sources.
## Contributing
-We love contributions! Take a look at
-[our contributing
page](https://github.com/apache/logging-log4j2/blob/master/CONTRIBUTING.md).
+We love contributions!
+Take a look at [our contributing page](CONTRIBUTING.md).
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 49c2bfeb22..d1504659c6 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -202,6 +202,9 @@
</action>
</release>
<release version="2.18.1" date="2022-MM-DD" description="GA Release
2.18.1">
+ <action issue="LOG4J2-3573" dev="vy" type="remove" due-to=" Wolff Bock
von Wuelfingen">
+ Removed build page in favor of a single build instructions file.
+ </action>
<action issue="LOG4J2-3550" dev="rgoers" type="fix"
due-to="DongjianPeng">
SystemPropertyAribiter was assigning the value as the name.
</action>
diff --git a/src/site/asciidoc/build.adoc b/src/site/asciidoc/build.adoc
deleted file mode 100644
index c16f25be0b..0000000000
--- a/src/site/asciidoc/build.adoc
+++ /dev/null
@@ -1,70 +0,0 @@
-////
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-////
-
-= Building and Installing Log4j
-
-NOTE: The information below is for developers who want to modify Log4j or
contribute
-to Log4j. If your goal is to add logging to your application you don't need to
-build from the source code, you can link:download.html[download] the pre-built
-binaries instead.
-
-Log4j 2 is hosted in the Apache Software Foundation's Git repository. Details
on obtaining the
-most current source code can be found at
-link:source-repository.html[Log4j Source Repository]. The source from the
latest release may be
-obtained by downloading it using the instructions at link:download.html[Log4j
Downloads].
-
-Log4j 2.x uses Maven 3 as its build tool. Log4j 2.x uses the Java 9 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
-following when invoking Maven.
-
-macOS:: `-t ./toolchains-sample-mac.xml`
-Windows:: `-t ./toolchains-sample-win.xml`
-GNU/Linux:: `-t ./toolchains-sample-linux.xml`
-
-To build and install Log4j in your local Maven cache, from the parent project
directory, and
-using Java 7 or 8, run: `mvn install`
-
-Note that if your `/etc/hosts` file does not include an entry for your
computer's hostname, then
-many unit tests may execute slowly due to DNS lookups to translate your
hostname to an IP address in
-http://docs.oracle.com/javase/7/docs/api/java/net/InetAddress.html#getLocalHost()[`InetAddress::getLocalHost`].
-To remedy this, you can execute the following:
-
-[source,bash]
-----
-printf '127.0.0.1 %s\n::1 %s\n' `hostname` `hostname` | sudo tee -a /etc/hosts
-----
-
-Then to build the full site, you must use a local staging directory:
-
-[source,bash]
-----
-mvn site
-# then if Windows:
-mvn site:stage-deploy -DstagingSiteURL=file:///%HOME%/log4j
-# else if Unix:
-mvn site:stage-deploy -DstagingSiteURL=file:///$HOME/log4j
-----
-
-To rebuild only what's changed and execute the tests, run: `mvn test`
-
-To rebuild from scratch, add "clean"; for example: `mvn clean test`
-
-== Releasing Log4j
-
-Please see the wiki
https://cwiki.apache.org/confluence/display/LOGGING/Log4j+2+Release+Process[Log4j
2 Release Process].
diff --git a/src/site/site.xml b/src/site/site.xml
index 26e152f913..0994657fd5 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -80,7 +80,6 @@
</menu>
<menu name="For Contributors" inherit="top"
img="img/glyphicons/pencil.png">
- <item name="Building Log4j from Source" href="/build.html"/>
<item name="Guidelines" href="/guidelines.html"/>
<item name="Style Guide" href="/javastyle.html"/>
</menu>
