You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by pk...@apache.org on 2024/05/30 11:09:27 UTC
(logging-log4j2) branch main updated (aa6d4335c1 -> 3c72777ec7)
This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
from aa6d4335c1 Fix broken links (mostly JavaDoc and Log4j API)
new 9e7f4cbd97 Revert "Add `sync` option to all tabs"
new 3c72777ec7 Add `tabs-sync-option`
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
antora-playbook.yaml | 1 +
.../antora/modules/ROOT/pages/manual/async.adoc | 4 ++--
.../modules/ROOT/pages/manual/configuration.adoc | 20 ++++++++---------
.../antora/modules/ROOT/pages/manual/filters.adoc | 2 +-
.../modules/ROOT/pages/manual/installation.adoc | 25 +++++++++++-----------
.../antora/modules/ROOT/pages/manual/scripts.adoc | 2 +-
6 files changed, 28 insertions(+), 26 deletions(-)
(logging-log4j2) 02/02: Add `tabs-sync-option`
Posted by pk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 3c72777ec77e4cee42dff40b882cea34e4381272
Author: Piotr P. Karwasz <pi...@karwasz.org>
AuthorDate: Thu May 30 13:05:46 2024 +0200
Add `tabs-sync-option`
---
antora-playbook.yaml | 1 +
1 file changed, 1 insertion(+)
diff --git a/antora-playbook.yaml b/antora-playbook.yaml
index 5377e5ba5e..5e14719aac 100644
--- a/antora-playbook.yaml
+++ b/antora-playbook.yaml
@@ -38,6 +38,7 @@ asciidoc:
log4j-docgen-type-filter-exclude-pattern: ^java\..+
log4j-docgen-type-target-template: |
#{{{replaceAll sourcedType.groupId "." "-"}}}_{{{replaceAll sourcedType.artifactId "." "-"}}}_{{{replaceAll sourcedType.type.className "." "-"}}}
+ tabs-sync-option: true
# Force Kroki to download images at build time
kroki-fetch-diagram: true
extensions:
(logging-log4j2) 01/02: Revert "Add `sync` option to all tabs"
Posted by pk...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
pkarwasz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit 9e7f4cbd974ad77928fe67a457a37df2a78f0b3b
Author: Piotr P. Karwasz <pi...@karwasz.org>
AuthorDate: Thu May 30 13:08:57 2024 +0200
Revert "Add `sync` option to all tabs"
This reverts commit 02309158d7fb6558c25c18411ef07c680ae664e1.
---
.../antora/modules/ROOT/pages/manual/async.adoc | 4 ++--
.../modules/ROOT/pages/manual/configuration.adoc | 20 ++++++++---------
.../antora/modules/ROOT/pages/manual/filters.adoc | 2 +-
.../modules/ROOT/pages/manual/installation.adoc | 25 +++++++++++-----------
.../antora/modules/ROOT/pages/manual/scripts.adoc | 2 +-
5 files changed, 27 insertions(+), 26 deletions(-)
diff --git a/src/site/antora/modules/ROOT/pages/manual/async.adoc b/src/site/antora/modules/ROOT/pages/manual/async.adoc
index 1c537ae9e8..a0f4b25ccd 100644
--- a/src/site/antora/modules/ROOT/pages/manual/async.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/async.adoc
@@ -96,7 +96,7 @@ at its default value and use one of the
A configuration that mixes asynchronous loggers might look like:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -161,7 +161,7 @@ link:../javadoc/log4j-async-logger/org/apache/logging/log4j/async/logger/AsyncWa
. Add an xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-async-AsyncWaitStrategyFactoryConfig[AsyncWaitStrategyFactory Log4j plugin]
to your configuration.
-[tabs,opts=sync]
+[tabs]
====
XML::
+
diff --git a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
index 4db98202d7..be60dfe0ec 100644
--- a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
@@ -139,7 +139,7 @@ They are **matched by type** against the list of nested components a plugin acce
Log4j maps the concepts above to the specifics of the configuration format as follows:
-[tabs,opts=sync]
+[tabs]
=====
XML::
+
@@ -278,7 +278,7 @@ See xref:manual/layouts.adoc[Layout configuration] for details.
A moderately complex configuration might look like this:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -470,7 +470,7 @@ xref:manual/architecture.adoc#loggerconfig[architecture]), which determines the
Let's start with an example of logger configuration:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -654,7 +654,7 @@ The `value` of each property is subject to <<property-substitution,property subs
Therefore, if you wish to insert a value that changes in time, you must double the `$` sign, as shown in the example below.
====
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -733,7 +733,7 @@ Log4j provides a simple and extensible mechanism to reuse values in the configur
Reusable configuration values can be added directly to a configuration file by using a xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-logging-log4j-core-config-PropertiesPlugin[Properties] component.
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -833,7 +833,7 @@ The same rule applies to the `name` parameter: if it contains a `${` sequence, i
If your configuration file contains the following definitions:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -890,7 +890,7 @@ The only exception to this rule is the expansion of properties in the `Propertie
Properties defined in the `Properties` container can depend on each other.
If your configuration contains, for example:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -952,7 +952,7 @@ In this case, you only need one dollar `$` sign.
+
This case happens for the children of the `Route` element below:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -1008,7 +1008,7 @@ xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-loggin
For example, you might want to use a different layout in a production and development environment:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
@@ -1048,7 +1048,7 @@ This is a case when the `Select` plugin is useful: this configuration element co
`DefaultArbiter` element.
If none of the arbiters match, the configuration from the `DefaultArbiter` element will be used:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
diff --git a/src/site/antora/modules/ROOT/pages/manual/filters.adoc b/src/site/antora/modules/ROOT/pages/manual/filters.adoc
index 4eb536b82f..1913771c83 100644
--- a/src/site/antora/modules/ROOT/pages/manual/filters.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/filters.adoc
@@ -32,7 +32,7 @@ NEUTRAL:: Log4j behaves as if the filter was not present.
To decide whether a log event from a certain logger is delivered to a specific appender, the following procedure is followed:
-[tabs,opts=sync]
+[tabs]
====
XML::
+
diff --git a/src/site/antora/modules/ROOT/pages/manual/installation.adoc b/src/site/antora/modules/ROOT/pages/manual/installation.adoc
index a858a51de8..bc538a066a 100644
--- a/src/site/antora/modules/ROOT/pages/manual/installation.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/installation.adoc
@@ -14,6 +14,7 @@
See the License for the specific language governing permissions and
limitations under the License.
////
+
:jcl-link: https://commons.apache.org/proper/commons-logging/[JCL (Apache Commons Logging)]
:jpl-link: https://openjdk.org/jeps/264[JPL (Java Platform Logging)]
:jul-link: https://docs.oracle.com/en/java/javase/{java-target-version}/core/java-logging-overview.html[JUL (Java Logging)]
@@ -156,7 +157,7 @@ The rest of the instructions in this page assume you use one of these.
To keep your Log4j module versions in sync with each other, a BOM (Bill of Material) file is provided for your convenience.
You can import the BOM in your build tool of preference:
-[tabs,opts=sync]
+[tabs]
====
Maven::
+
@@ -203,7 +204,7 @@ You can access the latest development snapshots by using the `https://repository
Snapshots are published for development and testing purposes; **they should not be used at production!**
=====
-[tabs,opts=sync]
+[tabs]
=====
Maven::
+
@@ -238,7 +239,7 @@ repositories {
The easiest way to install Log4j API is through a dependency management tool such as Maven or Gradle, by adding the following dependency:
-[tabs,opts=sync]
+[tabs]
====
Maven::
+
@@ -313,7 +314,7 @@ You can directly skip to xref:#impl-core-spring-boot[].
To install Log4j Core as your logging implementation, you need to add the following dependency to your application:
-[tabs,opts=sync]
+[tabs]
====
Maven::
+
@@ -364,7 +365,7 @@ The following sections explain the installation of Log4j-provided bridges.
You can translate {slf4j-link} calls to Log4j API using the `log4j-slf4j2-impl` artifact:
-[tabs,opts=sync]
+[tabs]
====
Maven::
+
@@ -391,7 +392,7 @@ runtimeOnly 'org.apache.logging.log4j:log4j-slf4j2-impl' // SLF4J-to-Log4j bridg
You can translate {jul-link} calls to Log4j API using the `log4j-jul` artifact:
-[tabs,opts=sync]
+[tabs]
====
Maven::
+
@@ -427,7 +428,7 @@ to the JVM parameters in your application launcher.
You can translate {jpl-link} calls to Log4j API using the `log4j-jpl` artifact:
-[tabs,opts=sync]
+[tabs]
====
Maven::
+
@@ -457,7 +458,7 @@ Since version `1.3.0` https://commons.apache.org/proper/commons-logging/[Apache
You can enforce the version of a transitive dependency using the dependency management mechanism appropriate to your
build tool:
-[tabs,opts=sync]
+[tabs]
====
Maven::
Maven users should add an entry to the `<dependencyManagement>` section of their POM file:
@@ -489,7 +490,7 @@ https://github.com/jboss-logging/jboss-logging?tab=readme-ov-file#supported-log-
Spring Boot users should replace the `spring-boot-starter-logging` dependency with `spring-boot-starter-log4j2`:
-[tabs,opts=sync]
+[tabs]
====
Maven::
@@ -545,7 +546,7 @@ Log4j Core supports many different configuration formats: JSON, XML, YAML, and J
To configure Log4j Core, see xref:manual/configuration.adoc[].
A basic configuration can be obtained by adding one of these files to your application's classpath:
-[tabs,opts=sync]
+[tabs]
====
log4j2.xml::
@@ -646,7 +647,7 @@ You can skip this section and use the https://github.com/jboss-logging/log4j2-jb
Java Platform contains a very simple logging API and its implementation called {jul-link}.
Since it is embedded in the platform, it only requires the addition of bridges from Log4j API and SLF4J:
-[tabs,opts=sync]
+[tabs]
====
Maven::
@@ -692,7 +693,7 @@ To configure JUL, see https://docs.oracle.com/en/java/javase/{java-target-versio
To install https://logback.qos.ch/[Logback] as the logging implementation, you only need to add a Log4j-to-SLF4J bridge:
-[tabs,opts=sync]
+[tabs]
====
Maven::
diff --git a/src/site/antora/modules/ROOT/pages/manual/scripts.adoc b/src/site/antora/modules/ROOT/pages/manual/scripts.adoc
index bd9c000a56..d705da347b 100644
--- a/src/site/antora/modules/ROOT/pages/manual/scripts.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/scripts.adoc
@@ -74,7 +74,7 @@ xref:plugin-reference.adoc#org-apache-logging-log4j_log4j-core_org-apache-loggin
The environment in which the script runs is different for each Log4j script-based component.
-[tabs,opts=sync]
+[tabs]
====
XML::
+