Skip to content

Commit 75061eb

Browse files
committed
fix: Javadoc and documentation problems
1 parent c9fbc53 commit 75061eb

File tree

3 files changed

+42
-13
lines changed

3 files changed

+42
-13
lines changed

log4j-api/src/main/java/org/apache/logging/log4j/internal/map/UnmodifiableArrayBackedMap.java

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -269,10 +269,6 @@ public UnmodifiableArrayBackedMap copyAndPut(String key, String value) {
269269
/**
270270
* Creates a new instance that contains the same entries as this map, plus the
271271
* new entries or updated values passed in the parameters.
272-
*
273-
* @param key
274-
* @param value
275-
* @return
276272
*/
277273
public UnmodifiableArrayBackedMap copyAndPutAll(Map<String, String> entriesToAdd) {
278274
// create a new array that can hold the maximum output size
@@ -304,10 +300,6 @@ public UnmodifiableArrayBackedMap copyAndPutAll(Map<String, String> entriesToAdd
304300
/**
305301
* Creates a new instance that contains the same entries as this map, minus the
306302
* entry with the specified key (if such an entry exists).
307-
*
308-
* @param key
309-
* @param value
310-
* @return
311303
*/
312304
public UnmodifiableArrayBackedMap copyAndRemove(String key) {
313305
int indexToRemove = -1;

src/changelog/2.25.0/.release-notes.adoc.ftl

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ https://www.graalvm.org/latest/reference-manual/native-image/metadata/[GraalVM r
3030
enabling seamless generation of native images with GraalVM out of the box—no manual configuration required.
3131
For more information, refer to our xref:graalvm.adoc[GraalVM guide].
3232

33+
[NOTE]
34+
====
35+
When building third-party Log4j plugins, using the new `GraalVmProcessor`
36+
introduced in version `2.25.0` will automatically generate the required reachability metadata for GraalVM native images.
37+
However, the processor will fail the build if the required `log4j.graalvm.groupId` and `log4j.graalvm.artifactId` parameters are not provided.
38+
For detailed instructions, see xref:manual/plugins.adoc#plugin-registry[Registering plugins].
39+
====
40+
3341
[#release-notes-2-25-0-PL-ex]
3442
=== Exception Handling in Pattern Layout
3543

@@ -39,7 +47,7 @@ Key improvements include:
3947

4048
* Stack traces are now consistently prefixed with a newline instead of other whitespace.
4149
* The default exception converter has changed from xref:manual/pattern-layout.adoc#converter-exception-extended[extended] to xref:manual/pattern-layout.adoc#converter-exception[plain], offering better performance.
42-
* Support for the `{ansi}` option in exception converters has been removed.
50+
* Support for the `\{ansi}` option in exception converters has been removed.
4351

4452
[#release-notes-2-25-0-instant-format]
4553
=== Date & Time Formatting
@@ -51,7 +59,7 @@ These are now deprecated in favor of Java’s standard
5159
https://docs.oracle.com/javase/{java-target-version}/docs/api/java/time/format/DateTimeFormatter.html[`DateTimeFormatter`].
5260

5361
If you encounter formatting issues after upgrading—particularly with `n` or `x` directives—you can temporarily revert to the legacy formatters by setting the xref:manual/systemproperties.adoc#log4j2.instantFormatter[`log4j2.instantFormatter`] property to `legacy`.
54-
Please report any issues via our {logging-services-url}/support.html#issues\[issue tracker].
62+
Please report any issues via our {logging-services-url}/support.html#issues[issue tracker].
5563

5664
[#release-notes-2-25-0-windows-ansi]
5765
=== ANSI Support on Windows

src/site/antora/modules/ROOT/pages/manual/appenders/message-queue.adoc

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -424,7 +424,7 @@ This example cannot be configured using Java properties.
424424
== JMS Appender
425425
426426
The JMS Appender sends a formatted log event to a
427-
https://jakarta.ee/specifications/messaging/3.0/[Jakarta] or https://jakarta.ee/specifications/messaging/2.0/[Javax] Messaging API
427+
https://jakarta.ee/specifications/messaging/3.0/[Jakarta] or https://jakarta.ee/specifications/messaging/2.0/[Java] EE Messaging API
428428
destination.
429429
430430
[IMPORTANT]
@@ -434,9 +434,38 @@ xref:manual/systemproperties.adoc#log4j2.enableJndiJms[`log4j2.enableJndiJms`]
434434
configuration property to `true`.
435435
====
436436
437-
For Jakarta, use the `JMS-Jakarta` element name in the `log4j-jakarta-jms` Maven module.
437+
[WARNING]
438+
=====
439+
Starting with Log4j `2.25.0`, the correct Appender element name depends on the version of Jakarta Messaging you are using:
440+
441+
* **For Jakarta Messaging 3.0 or later**, use the `JMS-Jakarta` element name.
442+
This requires additional runtime dependencies:
443+
+
444+
[tabs]
445+
====
446+
Maven::
447+
+
448+
[source,xml,subs="+attributes"]
449+
----
450+
<dependency>
451+
<groupId>org.apache.logging.log4j</groupId>
452+
<artifactId>log4j-jakarta-jms</artifactId>
453+
<version>{log4j-core-version}</version>
454+
</dependency>
455+
----
438456
439-
For Javax, use the `JMS-Javax` element name; the names `JMS`, `JMSQueue`, and `JMSTopic` are provided for backward compatibility.
457+
Gradle::
458+
+
459+
[source,groovy,subs="+attributes"]
460+
----
461+
runtimeOnly 'org.apache.logging.log4j:log4j-jakarta-jms:{log4j-core-version}'
462+
----
463+
====
464+
465+
* **For Java Messaging or Jakarta Messaging 2.0**, use the `JMS-Javax` element name instead.
466+
467+
The legacy element names `JMS`, `JMSQueue`, and `JMSTopic` are still supported for backward compatibility.
468+
=====
440469
441470
[#JmsAppender-attributes]
442471
.JMS Appender configuration attributes

0 commit comments

Comments
 (0)