This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x by this push:
new 8069c73c97 Refactor dependencies required by compression
8069c73c97 is described below
commit 8069c73c971f67dabcf01a6564ba0f91511be0f5
Author: Piotr P. Karwasz <[email protected]>
AuthorDate: Thu Sep 12 21:07:31 2024 +0200
Refactor dependencies required by compression
---
.../ROOT/pages/manual/appenders/rolling-file.adoc | 27 +++-----------
.../ROOT/partials/features/compression.adoc | 42 ++++++++++++++++++++++
2 files changed, 46 insertions(+), 23 deletions(-)
diff --git
a/src/site/antora/modules/ROOT/pages/manual/appenders/rolling-file.adoc
b/src/site/antora/modules/ROOT/pages/manual/appenders/rolling-file.adoc
index 226d5bec48..1982182fd2 100644
--- a/src/site/antora/modules/ROOT/pages/manual/appenders/rolling-file.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/appenders/rolling-file.adoc
@@ -971,30 +971,11 @@ If the
<<RolloverStrategy-attr-tempCompressedFilePattern,`tempCompressedFilePatt
^dep^::
Additional dependencies are required to use these compression algorithms:
+
-[tabs]
-====
-Maven::
-+
-[source,xml,subs=+attributes]
-----
-<dependency>
- <groupId>org.apache.commons</groupId>
- <artifactId>commons-compress</artifactId>
- <version>{commons-compress-version}</version>
- <scope>runtime</scope>
-</dependency>
-----
-
-Gradle::
-+
-[source,groovy,subs=+attributes]
-----
-runtimeOnly 'org.apache.commons:commons-compress:{commons-compress-version}'
-----
-
-====
+--
+include::partial$features/compression.adoc[]
+--
+
-The `.xz` and `.zst` extensions require **additional** Commons Compress
dependencies.
+The `.xz` and `.zst` extensions require **additional** dependencies.
See
https://commons.apache.org/proper/commons-compress/index.html[Commons Compress
documentation]
for more details.
diff --git a/src/site/antora/modules/ROOT/partials/features/compression.adoc
b/src/site/antora/modules/ROOT/partials/features/compression.adoc
new file mode 100644
index 0000000000..d77b6f15f1
--- /dev/null
+++ b/src/site/antora/modules/ROOT/partials/features/compression.adoc
@@ -0,0 +1,42 @@
+////
+ 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.
+////
+
+// This file exists in both the 2.x and 3.x branches.
+// It contains the dependencies required to enable advanced compression
algorithms.
+
+[tabs]
+====
+Maven::
++
+[source,xml,subs=+attributes]
+----
+<dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-compress</artifactId>
+ <version>{commons-compress-version}</version>
+ <scope>runtime</scope>
+</dependency>
+----
+
+Gradle::
++
+[source,groovy,subs=+attributes]
+----
+runtimeOnly 'org.apache.commons:commons-compress:{commons-compress-version}'
+----
+
+====
\ No newline at end of file
