This is an automated email from the ASF dual-hosted git repository.
grobmeier pushed a commit to branch ms12_conversion_of_md_files
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/ms12_conversion_of_md_files by
this push:
new 708b8d8c4b added bill of materials and other parts from artifacts file
708b8d8c4b is described below
commit 708b8d8c4b848f58e0fce7e7dfa0fafb41ed2d30
Author: Christian Grobmeier <[email protected]>
AuthorDate: Wed Mar 6 14:18:51 2024 +0100
added bill of materials and other parts from artifacts file
---
src/site/asciidoc/download.adoc | 49 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 49 insertions(+)
diff --git a/src/site/asciidoc/download.adoc b/src/site/asciidoc/download.adoc
index 8c3e942372..cb16d0796e 100644
--- a/src/site/asciidoc/download.adoc
+++ b/src/site/asciidoc/download.adoc
@@ -27,6 +27,7 @@ https://www.apache.org/licenses/LICENSE-2.0.html[Apache
License, version 2.0].
The preferred way to use Log4j in your project is to use a build system as
Maven.
Please add the following to your build systems configuration file `pom.xml` to
use Log4j.
+Log4j needs two dependencies, since it is separated between the API and the
Core.
[source,xml,indent=0,role="primary"]
.Maven (pom.xml)
@@ -63,6 +64,54 @@ compile
'org.apache.logging.log4j:log4j-core:{project-version}'
</dependencies>
----
+== Bill of materials
+
+
+To keep your Log4j module versions in sync with each other, a <abbr id="Bill
of Material">BOM</abbr>
+pom.xml file is provided for your convenience. To use this with
[Maven](https://maven.apache.org/),
+add the dependency listed below to your `pom.xml` file.
+When you specify the version identifier in this section, you don't have to
specify the version in your `<dependencies/>` section.
+
+[source,xml,indent=0,role="primary"]
+.Maven (pom.xml)
+----
+<dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-bom</artifactId>
+ <version>{project-version}</version>
+ <scope>import</scope>
+ <type>pom</type>
+ </dependency>
+ </dependencies>
+</dependencyManagement>
+----
+
+[source,indent=0,role="secondary"]
+.Gradle (build.gradle)
+----
+plugins {
+ id 'io.spring.dependency-management' version '1.0.1.RELEASE'
+}
+
+dependencyManagement {
+ imports {
+ mavenBom 'org.apache.logging.log4j:log4j-bom:{project-version}'
+ }
+}
+
+dependencies {
+ implementation 'org.apache.logging.log4j:log4j-api'
+ implementation 'org.apache.logging.log4j:log4j-core'
+ // etc.
+}
+----
+
+To use this with Gradle, an additional [Gradle
plugin](https://github.com/spring-gradle-plugins/dependency-management-plugin)
+is required for dependency management functionality.
+
+
== Manual Download
The link in the Mirrors column should display a list of available
