Jan Kursawe created LOG4J2-1214:
-----------------------------------
Summary: Misleading documentation of PatternLayout
Key: LOG4J2-1214
URL: https://issues.apache.org/jira/browse/LOG4J2-1214
Project: Log4j 2
Issue Type: Documentation
Components: Layouts
Affects Versions: 2.1
Environment: platform independently
Reporter: Jan Kursawe
Priority: Minor
The documentation for the PatternLayout on the Website
https://logging.apache.org/log4j/log4j-2.1/manual/layouts.html#PatternLayout
contains the following wrong statement:
The character set to use when converting the syslog String to a byte array. The
String must be a valid Charset. {color:red}*If not specified, the default
system Charset will be used.*{color}
The Java-Doc states no information:
{code}
[...]
@param charset The character set.
[...]
{code}
The implementation look like the following:
{code}
@PluginAttribute(value = "charset", defaultString = "UTF-8") final Charset
charset,
{code}
The fallback default charset is not the system's charset. It's always UTF-8
That difference leads up to an encoding issue when an instance writes messages
to a logger with system's charset different from UTF-8.
----
+Tasks:+
(x) inform persons in power of JavaDoc and WebsiteDoc
(x) Change the documentation on website
(x) Add more information to JavaDoc
(x) review by responsible persons
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
