This is an automated email from the ASF dual-hosted git repository.
rgupta pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j-kotlin.git
The following commit(s) were added to refs/heads/main by this push:
new 8da2069 Document Maven issue with transitive log4j-api version
resolution (#147)
8da2069 is described below
commit 8da206942c1c5e811a30dc64cfbbe5ca21659f76
Author: Raman Gupta <[email protected]>
AuthorDate: Tue Mar 31 11:30:25 2026 -0400
Document Maven issue with transitive log4j-api version resolution (#147)
* Document Maven issue with transitive log4j-api version resolution
* Add link to BOM instructions
---
src/site/antora/modules/ROOT/pages/index.adoc | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)
diff --git a/src/site/antora/modules/ROOT/pages/index.adoc
b/src/site/antora/modules/ROOT/pages/index.adoc
index a239ad1..473865b 100644
--- a/src/site/antora/modules/ROOT/pages/index.adoc
+++ b/src/site/antora/modules/ROOT/pages/index.adoc
@@ -32,7 +32,9 @@ Your application still needs to have a logging backend (e.g.,
{log4j-url}[Log4j]
[#dependencies]
== Dependencies
-You need to have the `org.apache.logging.log4j:log4j-api-kotlin` dependency in
your classpath:
+You need to have the `org.apache.logging.log4j:log4j-api-kotlin` dependency in
your classpath.
+
+With Maven:
[source,xml,subs="+attributes"]
----
@@ -43,6 +45,17 @@ You need to have the
`org.apache.logging.log4j:log4j-api-kotlin` dependency in y
</dependency>
----
+or with Gradle:
+
+[source,kotlin,subs="+attributes"]
+----
+implementation("org.apache.logging.log4j:log4j-api-kotlin:{project-version}")
+----
+
+Note that `log4j-api-kotlin` has a transitive dependency on `log4j-api`.
+Since `log4j-core` *also* depends transitively on `log4j-api`, this may result
in Maven downgrading the `-api` artifact which can
https://github.com/apache/logging-log4j-kotlin/issues/144#issuecomment-4090207780[cause
issues].
+We recommend that projects
https://logging.apache.org/log4j/2.x/manual/installation.html[leverage the
`log4j-bom`] as well.
+
Java module name and OSGi `Bundle-SymbolicName` are set to
`org.apache.logging.log4j.api.kotlin`.
[#create-loggers]
