You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2022/08/18 12:25:03 UTC
[logging-log4j2] branch release-2.x updated: LOG4J2-3573 Removed build page in favor of a single build instructions file.
This is an automated email from the ASF dual-hosted git repository.
vy 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 4d1d780d0b LOG4J2-3573 Removed build page in favor of a single build instructions file.
4d1d780d0b is described below
commit 4d1d780d0be0bea6a3005c1a191aa90b3ba20813
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Thu Aug 18 14:24:34 2022 +0200
LOG4J2-3573 Removed build page in favor of a single build instructions file.
---
BUILDING.md | 24 +++++++++++++---
README.md | 27 +++++++++++++-----
src/changes/changes.xml | 3 ++
src/site/markdown/build.md | 69 ----------------------------------------------
src/site/site.xml | 1 -
5 files changed, 43 insertions(+), 81 deletions(-)
diff --git a/BUILDING.md b/BUILDING.md
index 1dd2061be0..f988246a40 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -14,6 +14,7 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
+
# Requirements
* JDK 8 and 9+
@@ -23,23 +24,38 @@
<a name="toolchains"></a>
# Configuring Maven Toolchains
-Maven Toolchains is used to employ both JDKs during compilation.
+Maven Toolchains is used to employ multiple JDKs required for compilation.
You either need to have a user-level configuration in `~/.m2/toolchains.xml` or explicitly provide one to the Maven: `./mvnw --global-toolchains /path/to/toolchains.xml`.
-See `.github/workflows/maven-toolchains.xml` used by CI for a sample Maven Toolchains configuration.
+See [`.github/workflows/maven-toolchains.xml`](.github/workflows/maven-toolchains.xml) used by CI for a sample Maven Toolchains configuration.
Note that this file requires `JAVA_HOME_8_X64` and `JAVA_HOME_11_X64` environment variables to be defined, though these can very well be hardcoded.
+<a name="building"></a>
# Building the sources
You can build and verify the sources as follows:
./mvnw verify
-To speed up build, you can skip verification and increase concurrency:
+`verify` goal runs validation and test steps next to building (i.e., compiling) the sources.
+To speed up the build, you can skip verification and try increasing the concurrency:
./mvwn -DskipTests -T8C package
-If you want to install generated artifacts to your local Maven repository, replace above `veriy` and/or `package` goals with `install`.
+If you want to install generated artifacts to your local Maven repository, replace above `verify` and/or `package` goals with `install`.
+
+<a name="dns"></a>
+## DNS lookups in tests
+
+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:
+
+```
+printf '127.0.0.1 %s\n::1 %s\n' `hostname` `hostname` | sudo tee -a /etc/hosts
+```
+<a name="website"></a>
# Building the website and manual
You can build the website and manual as follows:
diff --git a/README.md b/README.md
index 6a39d2ce05..09859233e6 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 2](https://logging.apache.org/log4j/2.x/)
Apache Log4j 2 is an upgrade to Log4j that provides significant improvements over its predecessor, Log4j 1.x,
@@ -94,13 +111,9 @@ JIRA issue in the Pull Request.
## Building From Source
-Log4j requires 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 de42842d74..9fb0ee47c8 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -30,6 +30,9 @@
- "remove" - Removed
-->
<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/markdown/build.md b/src/site/markdown/build.md
deleted file mode 100644
index 3d92f016ff..0000000000
--- a/src/site/markdown/build.md
+++ /dev/null
@@ -1,69 +0,0 @@
-<!-- vim: set syn=markdown : -->
-<!--
- 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
-
-*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 [download](download.html) 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
-[Log4j Source Repository](source-repository.html). The source from the latest release may be
-obtained by downloading it using the instructions at [Log4j Downloads](download.html).
-
-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.
-
-```
-[Macintosh] -t ./toolchains-sample-mac.xml
-[Windows] -t ./toolchains-sample-win.xml
-[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
-<a class="javadoc" href="http://docs.oracle.com/javase/7/docs/api/java/net/InetAddress.html#getLocalHost()">InetAddress::getLocalHost</a>.
-To remedy this, you can execute the following:
-
-```
-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:
-
-```
-mvn site
-[Windows] mvn site:stage-deploy -DstagingSiteURL=file:///%HOME%/log4j
-[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 [Log4j 2 Release Process](https://cwiki.apache.org/confluence/display/LOGGING/Log4j+2+Release+Process) wiki page.
diff --git a/src/site/site.xml b/src/site/site.xml
index 45674056e3..02915740ea 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>