Skip to content

Commit b2f20d1

Browse files
committed
Port system properties documentation to main
Part of #2525
1 parent a67367b commit b2f20d1

24 files changed

+1899
-1345
lines changed

log4j-async-logger/pom.xml

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
<description>Alternative implementation of logger that uses LMAX Disruptor.</description>
3232

3333
<properties>
34+
<maven.javadoc.skip>false</maven.javadoc.skip>
35+
3436
<bnd-extra-package-options>
3537
<!-- JSpecify is optional at runtime -->
3638
org.jspecify.annotations.*;resolution:=optional

src/site/antora/modules/ROOT/pages/javadoc.adoc

+7-5
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,17 @@
1616
////
1717
= Javadoc API Documentation
1818
19-
The table below contains links to the Javadoc API Documentation for the components you are most likely to use
20-
directly in code. You can also use the menu links on the left.
19+
The table below contains links to the Javadoc API Documentation for the components you are most likely to use directly in code.
2120
2221
|===
2322
|Component |Description
2423
25-
|link:javadoc/log4j-api[Log4j 3.x API]
24+
|link:/log4j/2.x/javadoc/log4j-api[Log4j 2 API]
2625
|The interface that applications should use and code against.
2726
28-
|link:javadoc/log4j-core[Implementation]
29-
|The standard implementation, also called the Log4j 3.x Core, that contains Appenders, Filters, and more.
27+
|link:javadoc/log4j-core/index.html[Implementation]
28+
|The standard implementation, also called the Log4j 3 Core, that contains Appenders, Filters, and more.
29+
30+
|link:javadoc/log4j-async-logger/index.html[Asynchronous logger]
31+
|An alternative asynchronous logger implementation for Log4j 3 Core, based on LMAX Disruptor.
3032
|===

src/site/antora/modules/ROOT/pages/manual/async.adoc

+142-457
Large diffs are not rendered by default.

src/site/antora/modules/ROOT/pages/manual/garbagefree.adoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,7 @@ are not garbage-free since they
103103
cause `java.util.concurrent.locks.AbstractQueuedSynchronizer$Node` objects to be created.
104104
The default wait strategy used by Log4j uses a synchronized block instead of a ReentrantLock to avoid this problem.
105105
The Yield and Sleep wait strategies are garbage-free. (For configuring predefined wait strategies, see
106-
xref:manual/async.adoc#SysPropsAllAsync[here] and
107-
xref:manual/async.adoc#SysPropsMixedSync-Async[here],
106+
xref:manual/systemproperties.adoc#properties-log4j-async-logger[here],
108107
you may also configure a xref:manual/async.adoc#WaitStrategy[custom wait strategy].)
109108
110109
=== Disabling Garbage-free Logging
@@ -125,7 +124,7 @@ performance is important, consider using Async Loggers.
125124
Instead of system properties, the above properties can also be specified
126125
in a file named `log4j2.component.properties` by including this file in
127126
the classpath of the application. See the
128-
xref:manual/configuration.adoc#SystemProperties[manual regarding system
127+
xref:manual/systemproperties.adoc[manual regarding system
129128
properties] for more info.
130129
131130
[#Appenders]
@@ -437,7 +436,7 @@ spike in service time adds queueing delay for many of the subsequent
437436
operations. Service time is easy to measure (and often looks good on
438437
paper) but is irrelevant for users since it omits the time spent waiting
439438
for service. For this reason we report response time: service time plus
440-
wait time. See the xref:manual/performance.adoc#responseTime[response time
439+
wait time. See the xref:manual/performance.adoc[response time
441440
section] of the performance page for more detail.
442441
443442
The response time test results below were all derived from running the

src/site/antora/modules/ROOT/pages/manual/logsep.adoc

+4-1
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,10 @@ in each web application.
109109
110110
The `JndiContextSelector` will not work unless `log4j2.enableJndi=true` is set as a system property
111111
or environment variable. See the
112-
xref:manual/configuration.adoc#enableJndi[log4j2.enableJndi] system property.
112+
xref:manual/systemproperties.adoc#log4j.jndi.enableContextSelector[log4j.jndi.enableContextSelector]
113+
configuration property.
114+
115+
xref:manual/systemproperties.adoc#log4j2
113116
114117
The exact method for setting system properties depends on the container.
115118
For Tomcat, edit `$CATALINA_HOME/conf/catalina.properties`. Consult the

0 commit comments

Comments
 (0)