Note using Log4j2PluginsCacheFileTransformer in doc
#1178
Conversation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Goooler
changed the title
Log4j2PluginsCacheFileTransformer in doc
| @@ -176,6 +176,18 @@ tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.Shadow | |||
| } | |||
| ``` | |||
|
|
|||
| ## Merging Log4j2 Plugin Cache Files (`Log4j2Plugins.dat`) | |||
|
|
|||
| `Log4j2PluginsCacheFileTransformer` is a `Transformer` that merges `META-INF/org/apache/logging/log4j/core/config/plugins/Log4j2Plugins.dat` plugin caches from all the jars | |||
There was a problem hiding this comment.
| `Log4j2PluginsCacheFileTransformer` is a `Transformer` that merges `META-INF/org/apache/logging/log4j/core/config/plugins/Log4j2Plugins.dat` plugin caches from all the jars | |
| `Log4j2PluginsCacheFileTransformer` is a `Transformer` that merges [`Log4j2Plugins.dat` plugin descriptors](https://logging.apache.org/log4j/2.x/manual/plugins.html#plugin-registry) from all the jars |
Nit: personally I prefer to call the "descriptors" instead of "caches", although "cache" was the original term used.
There was a problem hiding this comment.
https://logging.apache.org/log4j/2.x/manual/plugins.html#plugin-registry
This link indicates "Registering plugins" instead of "Log4j2Plugins.dat plugin descriptors" self, I'm worried there might be misleading here?
There was a problem hiding this comment.
You might be right.
Currently we don't have a better reference for that, just the "registering plugins" section and some answers in the FAQ.
Maybe you could point at the Shading/Shadowing FAQ entry, although that sections almost immediately points back at your documentation. 😉
There was a problem hiding this comment.
Alright. I'll leave the file path here just for now.
Co-authored-by: Piotr P. Karwasz <piotr@github.copernik.eu>
Log4j2PluginsCacheFileTransformer#1175.