Details
-
Task
-
Resolution: Unresolved
-
Major
-
None
-
None
-
None
-
Undefined
-
---
-
---
Description
While working on an RFE that required some documentation I noticed there are several broken links in the logging documentation. While it would be simple to just fix the links I feel the logging documentation needs an overhaul and should be updated in general. For this reason I've created this issue as critical.
Links
Several links that referred to inner-documentation links were broken long ago in the conversion to asciidoc. These need to be fixed. An example is the implicit dependencies link needs to be:
link:Developer_Guide.html#which-are-the-implicit-module-dependencies[implicit]
Logging API's
The logging API's should have some information on how they work. Possibly which implementation is used and if the user wants to use their own implementation which module dependencies need to be excluded.
In some cases too, log4j2 is an example, there could special permissions required if a security manager is enabled.
For log4j2 these are the required permissions:
// The getClassLoader permissions is required for the org.apache.logging.log4j.util.ProviderUtil. new RuntimePermission("getClassLoader"), // The FilePermissions is also for the org.apache.logging.log4j.util.ProviderUtil as it needs to read the JAR // for the service loader. new FilePermission("<<ALL FILES>>", "read"), // Required for the EnvironmentPropertySource System.getenv(). new RuntimePermission("getenv.*"), // Required for the SystemPropertiesPropertySource System.getProperties(). new PropertyPermission("*", "read,write"),
How To's
The How To section likely doesn't make much sense. This same documentation could be achieved in each logging API section.