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/29 10:26:02 UTC
(logging-log4j2) branch main updated: Uniformize links to JavaDoc
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
The following commit(s) were added to refs/heads/main by this push:
new 2a4add25ba Uniformize links to JavaDoc
2a4add25ba is described below
commit 2a4add25ba79ebd7561fb416d7853267eb1a3c43
Author: Piotr P. Karwasz <pi...@karwasz.org>
AuthorDate: Wed May 29 11:39:04 2024 +0200
Uniformize links to JavaDoc
---
.../antora/modules/ROOT/pages/manual/async.adoc | 4 +--
.../modules/ROOT/pages/manual/configuration.adoc | 16 ++++++---
.../ROOT/pages/manual/systemproperties.adoc | 9 +++--
.../manual/systemproperties/properties-async.adoc | 20 ++++++++---
.../manual/systemproperties/properties-auth.adoc | 28 ++++++++++-----
.../properties-configuration-factory.adoc | 21 +++++++----
.../properties-garbage-collection.adoc | 21 +++++++----
.../systemproperties/properties-log-event.adoc | 18 ++++++----
.../properties-log4j-core-misc.adoc | 31 +++++++++++-----
.../properties-logger-context.adoc | 42 ++++++++++++++--------
.../systemproperties/properties-message.adoc | 8 +++--
.../properties-thread-context.adoc | 7 ++--
12 files changed, 155 insertions(+), 70 deletions(-)
diff --git a/src/site/antora/modules/ROOT/pages/manual/async.adoc b/src/site/antora/modules/ROOT/pages/manual/async.adoc
index 9e89baf2c5..39233e69c7 100644
--- a/src/site/antora/modules/ROOT/pages/manual/async.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/async.adoc
@@ -69,10 +69,10 @@ This is the simplest to configure and gives the best performance: to make all lo
xref:manual/systemproperties.adoc#log4j.loggerContext.selector[`log4j.loggerContext.selector`]
property to one of the asynchronous logger context selectors:
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/BasicAsyncLoggerContextSelector[org.apache.logging.log4j.core.async.BasicAsyncLoggerContextSelector]::
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/BasicAsyncLoggerContextSelector.html[org.apache.logging.log4j.core.async.BasicAsyncLoggerContextSelector]::
This will create a single logger context and disruptor for all the classes in the JVM,
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/AsyncLoggerContextSelector[org.apache.logging.log4j.core.async.AsyncLoggerContextSelector]::
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/AsyncLoggerContextSelector.html[org.apache.logging.log4j.core.async.AsyncLoggerContextSelector]::
This will create a different logger context and disruptor for each classloader in the JVM.
[IMPORTANT]
diff --git a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
index 675573b77e..11661fc63f 100644
--- a/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/configuration.adoc
@@ -51,7 +51,11 @@ Upon initialization of a new logger context, Log4j assigns it a context name and
. Files named `log4j2-test.<extension>`,
. Files named `log4j2<contextName>.<extension>`
. Files named `log4j2.<extension>`,
-. If no configuration file is found, Log4j uses the link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/DefaultConfiguration[DefaultConfiguration], and the status logger prints a warning.
+. If no configuration file is found, Log4j uses the
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/DefaultConfiguration.html[DefaultConfiguration]
+and the
+{log4j2-url}/manual/status-logger.html[status logger]
+prints a warning.
The default configuration prints all messages less specific than
xref:manual/systemproperties.adoc#log4j.configuration.level[log4j.configuration.level]
to the console.
@@ -60,7 +64,8 @@ to the console.
====
The configuration files prefixed by `log4j2-test` should only be used on the test classpath.
-If multiple configuration files in the same category are found, Log4j uses a deterministic order to choose one of them (see link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/Order[@Order]).
+If multiple configuration files in the same category are found, Log4j uses a deterministic order to choose one of them (see
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/Order.html[`@Order`]).
Nevertheless:
@@ -114,8 +119,11 @@ The Log4j runtime is composed of xref:manual/plugins.adoc[plugins], which are li
Appenders, layouts, filters, configuration loaders, and similar components are all accessed as plugins.
All configuration files are represented internally as a tree of
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/Node[Node]s, which is translated into a tree of Log4j plugins.
-The tree's root creates a link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/Configuration[Configuration] object.
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/Node.html[Node]s,
+which is translated into a tree of Log4j plugins.
+The tree's root creates a
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/Configuration.html[Configuration]
+object.
A node is a relatively simple structure representing a single Log4j plugin (see xref:plugin-reference.adoc[] for a complete list), such as an appender, layout, or logger configuration.
diff --git a/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc b/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc
index 3ffbb3dbc8..aa6a3ec306 100644
--- a/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc
+++ b/src/site/antora/modules/ROOT/pages/manual/systemproperties.adoc
@@ -127,10 +127,9 @@ include::partial$manual/systemproperties/properties-async.adoc[leveloffset=+2]
=== Logger context
The
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/LoggerContext.html[LoggerContext]
-is one of the principal Log4j components (see
-xref:manual/architecture.adoc[]), which determines among other things, the way
-{log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/Logger.html[Logger]s are created.
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ContextSelector.html[ContextSelector]
+component specifies the strategy used by Log4j to create new logger contexts.
+The choice of `ContextSelector` determines in particular:
It can be customized using these properties:
@@ -238,7 +237,7 @@ include::partial$manual/systemproperties/properties-log4j-script.adoc[leveloffse
== Property sources
The Log4j configuration properties sub-system is based on the
-link:../javadoc/log4j-kit/org/apache/logging/log4j/kit/env/PropertyEnvironment.html[PropertyEnvironment]
+{log4j2-url}/javadoc/log4j-kit/org/apache/logging/log4j/kit/env/PropertyEnvironment.html[PropertyEnvironment]
interface, which provides a type-safe access to configuration properties.
Two kinds of property environments are used by Log4j 3:
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-async.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-async.adoc
index 0955f6a60d..ccac514f09 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-async.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-async.adoc
@@ -26,19 +26,29 @@
If `false`, Log4j will make sure the message is formatted in the caller thread, otherwise the formatting will occur on the asynchronous thread.
-**Remark**: messages annotated with {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/AsynchronouslyFormattable[AsynchronouslyFormattable] will be formatted on the async thread regardless of this setting.
+**Remark**: messages annotated with
+{log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/AsynchronouslyFormattable.html[AsynchronouslyFormattable]
+will be formatted on the async thread regardless of this setting.
[id=log4j.async.queueFullPolicy.type]
== `log4j.async.queueFullPolicy.type`
[cols="1h,5"]
|===
-| Env. variable | LOG4J_ASYNC_QUEUE_FULL_POLICY_TYPE
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/AsyncQueueFullPolicy[Class<? extends AsyncQueueFullPolicy>] or predefined constant
-| Default value | `Default`
+| Env. variable
+| LOG4J_ASYNC_QUEUE_FULL_POLICY_TYPE
+
+| Type
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html[Class<? extends AsyncQueueFullPolicy>]
+or predefined constant
+
+| Default value
+| `Default`
|===
-Determines the link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/AsyncQueueFullPolicy[AsyncQueueFullPolicy] to use when the underlying async component cannot keep up with the logging rate and the queue is filling up.
+Determines the
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/AsyncQueueFullPolicy.html[AsyncQueueFullPolicy]
+to use when the underlying async component cannot keep up with the logging rate and the queue is filling up.
Its value should be the fully qualified class name of an `AsyncQueueFullPolicy` implementation or one of these predefined constants:
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-auth.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-auth.adoc
index c0b02e4ef4..4954d22dc8 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-auth.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-auth.adoc
@@ -20,13 +20,18 @@
[cols="1h,5"]
|===
-| Env. variable | LOG4J_AUTH_PROVIDER
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/AuthorizationProvider[Class<? extends AuthorizationProvider>]
-| Default value | link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/BasicAuthorizationProvider[BasicAuthorizationProvider]
+| Env. variable
+| LOG4J_AUTH_PROVIDER
+
+| Type
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/AuthorizationProvider.html[Class<? extends AuthorizationProvider>]
+
+| Default value
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/BasicAuthorizationProvider.html[BasicAuthorizationProvider]
|===
The fully qualified class name of the
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/AuthorizationProvider[AuthorizationProvider]
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/AuthorizationProvider.html[AuthorizationProvider]
implementation to use with `http` and `https` URL protocols.
[id=log4j.auth.basic.password]
@@ -48,12 +53,19 @@ If used in conjunction with <<log4j.auth.basic.passwordDecryptor>> the contents
[cols="1h,5"]
|===
-| Env. variable | LOG4J_AUTH_BASIC_PASSWORD_DECRYPTOR
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/PasswordDecryptor[Class<? extends PasswordDecryptor>]
-| Default value | `null`
+| Env. variable
+| LOG4J_AUTH_BASIC_PASSWORD_DECRYPTOR
+
+| Type
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/PasswordDecryptor.html[Class<? extends PasswordDecryptor>]
+
+| Default value
+| `null`
|===
-Fully qualified class name of an implementation of link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/PasswordDecryptor[PasswordDecryptor] to use for the value of the <<log4j.auth.basic.password>> property.
+Fully qualified class name of an implementation of
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/PasswordDecryptor.html[PasswordDecryptor]
+to use for the value of the <<log4j.auth.basic.password>> property.
If `null`, the literal value of the password is used.
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-configuration-factory.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-configuration-factory.adoc
index a270bc25e4..1dd2ba1203 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-configuration-factory.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-configuration-factory.adoc
@@ -20,11 +20,13 @@
[cols="1h,5"]
|===
| Env. variable | LOG4J_CONFIGURATION_FACTORY
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/ConfigurationFactory[Class<? extends ConfigurationFactory>]
+| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/ConfigurationFactory.html[Class<? extends ConfigurationFactory>]
| Default value | `null`
|===
-Specifies the fully qualified class name of the **preferred** link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/ConfigurationFactory[ConfigurationFactory] to use.
+Specifies the fully qualified class name of the **preferred**
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/ConfigurationFactory.html[ConfigurationFactory]
+to use.
Log4j will attempt to use the provided configuration factory before any other factory implementation.
@@ -70,9 +72,16 @@ Specifies the level of the root logger if:
[cols="1h,5"]
|===
-| Env. variable | LOG4J_MERGE_STRATEGY
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/composite/MergeStrategy[Class<? extends MergeStrategy>]
-| Default value | `link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/composite/DefaultMergeStrategy[DefaultMergeStrategy]`
+| Env. variable
+| LOG4J_MERGE_STRATEGY
+
+| Type
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/composite/MergeStrategy.html[Class<? extends MergeStrategy>]
+
+| Default value
+| `link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/composite/DefaultMergeStrategy.html[DefaultMergeStrategy]`
|===
-Specifies the fully qualified class name of the link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/composite/MergeStrategy[MergeStrategy] implementation used to merge multiple configuration files into one.
\ No newline at end of file
+Specifies the fully qualified class name of the
+`link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/composite/MergeStrategy.html[MergeStrategy]`
+implementation used to merge multiple configuration files into one.
\ No newline at end of file
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-garbage-collection.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-garbage-collection.adoc
index fdb3b19c39..c53dff444a 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-garbage-collection.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-garbage-collection.adoc
@@ -38,7 +38,8 @@ This prevents allocating temporary `String` and `char[]` instances.
| Default value | `8192`
|===
-The size in bytes of the link:../https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html[ByteBuffer]s stored in `ThreadLocal` fields by layouts and link:../javadoc/log4j-core/org/apache/logging/log4j/core/layout/StringBuilderEncoder[StringBuilderEncoder]s.
+The size in bytes of the https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html[ByteBuffer]s stored in `ThreadLocal` fields by layouts and
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/layout/StringBuilderEncoder.html[StringBuilderEncoder]s.
This setting is only used if <<log4j.gc.enableDirectEncoders>> is set to `true`.
@@ -52,7 +53,8 @@ This setting is only used if <<log4j.gc.enableDirectEncoders>> is set to `true`.
| Default value | `4096`
|===
-The size in ``char``s of the link:../https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html[ByteBuffer]s stored in `ThreadLocal` fields link:../javadoc/log4j-core/org/apache/logging/log4j/core/layout/StringBuilderEncoder[StringBuilderEncoder]s.
+The size in ``char``s of the https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html[ByteBuffer]s stored in `ThreadLocal` fields
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/layout/StringBuilderEncoder.html[StringBuilderEncoder]s.
This setting is only used if <<log4j.gc.enableDirectEncoders>> is set to `true`.
@@ -67,7 +69,9 @@ This setting is only used if <<log4j.gc.enableDirectEncoders>> is set to `true`.
| Default value | `128`
|===
-In GC-free mode, this property determines the initial size of the reusable ``StringBuilder``s used by {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/ReusableMessage[ReusableMessages] for formatting purposes.
+In GC-free mode, this property determines the initial size of the reusable ``StringBuilder``s used by
+{log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/ReusableMessage.html[ReusableMessages]
+for formatting purposes.
[id=log4j.gc.maxReusableMsgSize]
== `log4j.gc.maxReusableMsgSize`
@@ -79,7 +83,9 @@ In GC-free mode, this property determines the initial size of the reusable ``Str
| Default value | `518`
|===
-In GC-free mode, this property determines the maximum size of the reusable ``StringBuilder``s used by {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/ReusableMessage[ReusableMessages] for formatting purposes.
+In GC-free mode, this property determines the maximum size of the reusable ``StringBuilder``s used by
+{log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/ReusableMessage.html[ReusableMessages]
+for formatting purposes.
The default value allows is equal to `2 × (2 × log4j.initialReusableMsgSize + 2) + 2` and allows the
``StringBuilder`` to be resized twice by the current JVM resize algorithm.
@@ -95,7 +101,8 @@ The default value allows is equal to `2 × (2 × log4j.initialReusable
| Default value | `2048`
|===
-This property determines the maximum size of the reusable ``StringBuilder``s used to format link:../javadoc/log4j-core/org/apache/logging/log4j/core/LogEvent[LogEvents].
+This property determines the maximum size of the reusable ``StringBuilder``s used to format
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/LogEvent.html[`LogEvent`]s.
// tag::api[]
@@ -109,7 +116,9 @@ This property determines the maximum size of the reusable ``StringBuilder``s use
| Default value | `32`
|===
-The {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/util/Unbox[Unbox] utility class can be used by users to format primitive values without incurring in the boxing allocation cost.
+The
+{log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/util/Unbox.html[Unbox]
+utility class can be used by users to format primitive values without incurring in the boxing allocation cost.
This property specifies the maximum number of primitive arguments to a log message that will be cached and usually does not need to be changed.
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log-event.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log-event.adoc
index 313ad80610..d76a50edad 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log-event.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log-event.adoc
@@ -46,15 +46,19 @@ The implementation must have:
| LOG4J_LOG_EVENT_CONTEXT_DATA_INJECTOR
| Type
-| link:../javadoc/log4j-core/org/apache/logging/log4j/core/ContextDataInjector[Class<? extends ContextDataInjector>]
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/ContextDataInjector.html[Class<? extends ContextDataInjector>]
| Default value
| depends on the `ThreadContextMap` implementation
|===
-Fully qualified class name of a link:../javadoc/log4j-core/org/apache/logging/log4j/core/ContextDataInjector[ContextDataInjector] implementation.
+Fully qualified class name of a
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/ContextDataInjector.html[ContextDataInjector]
+implementation.
-The default implementation uses all implementations of link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/ContextDataProvider[ContextDataProvider] registered with `ServiceLoader`.
+The default implementation uses all implementations of
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/ContextDataProvider.html[ContextDataProvider]
+registered with `ServiceLoader`.
[id=log4j.logEvent.factory]
== `log4j.logEvent.factory`
@@ -65,10 +69,12 @@ The default implementation uses all implementations of link:../javadoc/log4j-cor
| LOG4J_LOG_EVENT_FACTORY
| Type
-| link:../javadoc/log4j-core/org/apache/logging/log4j/core/impl/LogEventFactory[Class<? extends LogEventFactory>]
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/impl/LogEventFactory.html[Class<? extends LogEventFactory>]
| Default value
-| link:../javadoc/log4j-core/org/apache/logging/log4j/core/impl/ReusableLogEventFactory[`ReusableLogEventFactory`]
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/impl/ReusableLogEventFactory.html[`ReusableLogEventFactory`]
|===
-Specifies the link:../javadoc/log4j-core/org/apache/logging/log4j/core/impl/LogEventFactory[LogEventFactory] implementation to use to create log events.
\ No newline at end of file
+Specifies the
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/impl/LogEventFactory.html[LogEventFactory]
+implementation to use to create log events.
\ No newline at end of file
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
index c20217dce1..919ef87a6f 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-log4j-core-misc.adoc
@@ -20,11 +20,13 @@
[cols="1h,5"]
|===
| Env. variable | LOG4J_CONFIGURATION_CLOCK
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/Clock[Class<? extends Clock>] or predefined constant
+| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/Clock.html[Class<? extends Clock>] or predefined constant
| Default value | ``SystemClock``
|===
-Specifies the link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/Clock[Clock] implementation used to timestamp log events.
+Specifies the
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/Clock.html[Clock]
+implementation used to timestamp log events.
This must be the fully qualified class name of the implementation or one of these predefined constants:
@@ -34,10 +36,14 @@ See https://docs.oracle.com/javase/{java-target-version}/docs/api/java/time/Cloc
SystemMillisClock:: same as `SystemClock`, but truncates the result to a millisecond.
CachedClock:: uses a separate thread to update the timestamp value.
-See link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/CachedClock[JavaDoc] for details.
+See
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/CachedClock.html[JavaDoc]
+for details.
CoarseCachedClock:: alternative implementation of `CachedClock` with a slightly lower precision.
-See link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/CoarseCachedClock[JavaDoc] for details.
+See
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/CoarseCachedClock.html[JavaDoc]
+for details.
[id=log4j.configuration.usePreciseClock]
== `log4j.configuration.usePreciseClock`
@@ -73,13 +79,20 @@ Otherwise, an attempt is made to load classes with the current thread's context
[cols="1h,5"]
|===
-| Env. variable | LOG4J_CONFIGURATION_RELIABILITY_STRATEGY
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/ReliabilityStrategy[Class<? extends
- ReliabilityStrategy>] or predefined constant
-| Default value | `AwaitCompletion`
+| Env. variable
+| LOG4J_CONFIGURATION_RELIABILITY_STRATEGY
+
+| Type
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/ReliabilityStrategy.html[Class<? extends ReliabilityStrategy>]
+or predefined constant
+
+| Default value
+| `AwaitCompletion`
|===
-Specifies the link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/ReliabilityStrategy[ReliabilityStrategy] to adopt in order to prevent loss of log events during a reconfiguration.
+Specifies the
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/config/ReliabilityStrategy.html[ReliabilityStrategy]
+to adopt in order to prevent loss of log events during a reconfiguration.
The value must be the fully qualified class name of a `ReliabilityStrategy` implementation or one of these predefined constants:
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-logger-context.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-logger-context.adoc
index 33ec0fa811..aa495e2208 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-logger-context.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-logger-context.adoc
@@ -19,12 +19,19 @@
[cols="1h,5"]
|===
-| Env. variable | LOG4J_LOGGER_CONTEXT_SELECTOR
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ContextSelector[Class<? extends ContextSelector>]
-| Default value | `link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ClassLoaderContextSelector[ClassLoaderContextSelector]`
+| Env. variable
+| LOG4J_LOGGER_CONTEXT_SELECTOR
+
+| Type
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ContextSelector.html[Class<? extends ContextSelector>]
+
+| Default value
+| `link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ClassLoaderContextSelector.html[ClassLoaderContextSelector]`
|===
-Specifies the fully qualified class name of the link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ContextSelector[ContextSelector] implementation to use.
+Specifies the fully qualified class name of the
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ContextSelector.html[ContextSelector]
+implementation to use.
A `ContextSelector` decides:
@@ -35,22 +42,22 @@ implementation to use.
The implementations available by default are:
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/BasicContextSelector[org.apache.logging.log4j.core.selector.BasicContextSelector]::
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/BasicContextSelector.html[org.apache.logging.log4j.core.selector.BasicContextSelector]::
Creates a single logger context and synchronous loggers
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/BasicAsyncLoggerContextSelector[org.apache.logging.log4j.core.async.BasicAsyncLoggerContextSelector]::
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/BasicAsyncLoggerContextSelector.html[org.apache.logging.log4j.core.async.BasicAsyncLoggerContextSelector]::
Creates a single logger context and xref:manual/async.adoc[asynchronous loggers]
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ClassLoaderContextSelector[org.apache.logging.log4j.core.selector.ClassLoaderContextSelector]::
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/ClassLoaderContextSelector.html[org.apache.logging.log4j.core.selector.ClassLoaderContextSelector]::
Creates a separate logger context per classloader and synchronous loggers
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/AsyncLoggerContextSelector[org.apache.logging.log4j.core.async.AsyncLoggerContextSelector]::
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/async/AsyncLoggerContextSelector.html[org.apache.logging.log4j.core.async.AsyncLoggerContextSelector]::
Creates a separate logger context per classloader and xref:manual/async.adoc[asynchronous loggers]
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/osgi/BundleContextSelector[org.apache.logging.log4j.core.osgi.BundleContextSelector]::
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/osgi/BundleContextSelector.html[org.apache.logging.log4j.core.osgi.BundleContextSelector]::
Creates a separate logger context per OSGi bundle and synchronous loggers
-link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/JndiContextSelector[org.apache.logging.log4j.core.selector.JndiContextSelector]::
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/selector/JndiContextSelector.html[org.apache.logging.log4j.core.selector.JndiContextSelector]::
Creates loggers contexts based on a JNDI lookup and synchronous loggers.
See
link:../../jakarta/log4j-jakarta-web.html#jndi[Web application]
@@ -75,12 +82,19 @@ If `true` a shutdown hook will be installed to stop the logger context when the
[cols="1h,5"]
|===
-| Env. variable | LOG4J_LOGGER_CONTEXT_SHUTDOWN_CALLBACK_REGISTRY
-| Type | link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/ShutdownCallbackRegistry[Class<? extends ShutdownCallbackRegistry>]
-| Default value | `link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/DefaultShutdownCallbackRegistry[DefaultShutdownCallbackRegistry]`
+| Env. variable
+| LOG4J_LOGGER_CONTEXT_SHUTDOWN_CALLBACK_REGISTRY
+
+| Type
+| link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/ShutdownCallbackRegistry.html[Class<? extends ShutdownCallbackRegistry>]
+
+| Default value
+| `link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/DefaultShutdownCallbackRegistry.html[DefaultShutdownCallbackRegistry]`
|===
-The fully qualified class name of a link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/ShutdownCallbackRegistry[ShutdownCallbackRegistry] implementation.
+The fully qualified class name of a
+link:../javadoc/log4j-core/org/apache/logging/log4j/core/util/ShutdownCallbackRegistry.html[ShutdownCallbackRegistry]
+implementation.
Integrators can use this to customize the shutdown order of the JVM.
The default implementation executes all shutdown actions in a separate `Thread` registered through https://docs.oracle.com/javase/8/docs/api/java/lang/Runtime.html#addShutdownHook-java.lang.Thread-[Runtime#addShutdownHook()].
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-message.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-message.adoc
index bbd64054bb..27dc050efb 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-message.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-message.adoc
@@ -23,10 +23,12 @@
| LOG4J_MESSAGE_FACTORY
| Type
-| {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/MessageFactory[Class<? extends MessageFactory>]
+| {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/MessageFactory.html[Class<? extends MessageFactory>]
| Default value
-| {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/ReusableMessageFactory[ReusableMessageFactory]
+| {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/ReusableMessageFactory.html[ReusableMessageFactory]
|===
-Fully qualified class name of a {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/MessageFactory[MessageFactory] implementation that will be used by loggers if no explicit factory was specified.
\ No newline at end of file
+Fully qualified class name of a
+{log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/message/MessageFactory.html[MessageFactory]
+implementation that will be used by loggers if no explicit factory was specified.
\ No newline at end of file
diff --git a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-thread-context.adoc b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-thread-context.adoc
index f9ad5ece5a..0a90323f86 100644
--- a/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-thread-context.adoc
+++ b/src/site/antora/modules/ROOT/partials/manual/systemproperties/properties-thread-context.adoc
@@ -61,7 +61,8 @@ If `false`, the `ThreadContext` map is disabled.
| LOG4J_THREAD_CONTEXT_MAP_TYPE
| Type
-| {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/spi/ThreadContextMap[Class<? extends ThreadContextMap>] or predefined constant
+| link:../javadoc/log4j-api/org/apache/logging/log4j/spi/ThreadContextMap.html[Class<? extends ThreadContextMap>]
+or predefined constant
| Default value
| `WebApp`
@@ -69,7 +70,9 @@ If `false`, the `ThreadContext` map is disabled.
(GC-free mode: `CopyOnWrite`)
|===
-Fully specified class name of a custom {log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/spi/ThreadContextMap[ThreadContextMap] implementation class or one of the predefined constants:
+Fully specified class name of a custom
+{log4j2-url}/javadoc/log4j-api/org/apache/logging/log4j/spi/ThreadContextMap.html[ThreadContextMap]
+implementation class or one of the predefined constants:
NoOp:: to disable the thread context,
WebApp:: a web application-safe implementation, that only binds JRE classes to `ThreadLocal` to prevent memory leaks,