You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
doc: Clarify and enhance GraalVmProcessor configuration example (#3786)
This update refines the `GraalVmProcessor` configuration example in response to feedback from #3755. The goal is to make the example more reliable and aligned with common Maven project setups. Key improvements include:
* **Ensuring consistent parameter usage:**
The example now adds `-Alog4j.graalvm.groupId` and `-Alog4j.graalvm.artifactId` to **all executions** of the Maven Compiler Plugin. This guarantees correct behavior regardless of the execution ID used in user projects.
* **Simplifying plugin execution setup:**
Instead of introducing a dedicated `generate-log4j-plugin-descriptor` execution, the example now modifies the existing `default-compile` execution. This reflects the most typical use case, where annotation processing and compilation occur together.
These changes aim to make the setup easier to adopt while reducing configuration errors.
Copy file name to clipboardExpand all lines: src/site/antora/modules/ROOT/pages/manual/plugins.adoc
+16-13Lines changed: 16 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -211,8 +211,8 @@ annotation processor creates such a file at compile-time.
211
211
212
212
[WARNING]
213
213
====
214
-
The `GraalVmProcessor` needs to know the `groupId` and `artifactId` coordinates of your project.
215
-
These must be supplied to the processor using the `log4j.graalvm.groupId` and `log4j.graalvm.artifactId` annotation processor options.
214
+
The `GraalVmProcessor` requires your project's `groupId` and `artifactId` to correctly generate the GraalVM reachability metadata file in the recommended location.
215
+
Provide these values to the processor using the `log4j.graalvm.groupId` and `log4j.graalvm.artifactId` annotation processor options.
216
216
====
217
217
218
218
You need to configure your build tool as follows to use both plugin processors:
0 commit comments