You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by mi...@apache.org on 2016/05/20 08:25:33 UTC
[1/3] logging-log4j2 git commit: Remove bogus Javadoc line
Repository: logging-log4j2
Updated Branches:
refs/heads/master b6b107a11 -> 1285b1e2f
Remove bogus Javadoc line
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/2a5fb92c
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/2a5fb92c
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/2a5fb92c
Branch: refs/heads/master
Commit: 2a5fb92c8eee6036655eabaf6bef5e87e6ad58b1
Parents: b6b107a
Author: Mikael St�ldal <mi...@magine.com>
Authored: Fri May 20 10:05:23 2016 +0200
Committer: Mikael St�ldal <mi...@magine.com>
Committed: Fri May 20 10:05:23 2016 +0200
----------------------------------------------------------------------
.../main/java/org/apache/logging/log4j/core/layout/YamlLayout.java | 1 -
1 file changed, 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2a5fb92c/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java
index b68b836..6401fac 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/YamlLayout.java
@@ -784,7 +784,6 @@ public final class YamlLayout extends AbstractJacksonLayout {
* The header pattern, defaults to {@code ""} if null.
* @param footerPattern
* The header pattern, defaults to {@code ""} if null.
- * @param footerPattern
* @param charset
* The character set to use, if {@code null}, uses "UTF-8".
* @return A YAML Layout.
[2/3] logging-log4j2 git commit: Remove bogus Javadoc line
Posted by mi...@apache.org.
Remove bogus Javadoc line
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/99632fce
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/99632fce
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/99632fce
Branch: refs/heads/master
Commit: 99632fcea3c578f6743c01901cd49cd86d14bf8d
Parents: 2a5fb92
Author: Mikael St�ldal <mi...@magine.com>
Authored: Fri May 20 10:08:57 2016 +0200
Committer: Mikael St�ldal <mi...@magine.com>
Committed: Fri May 20 10:08:57 2016 +0200
----------------------------------------------------------------------
.../main/java/org/apache/logging/log4j/core/layout/JsonLayout.java | 1 -
1 file changed, 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/99632fce/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java
index 2d221d1..ff4bf0b 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/layout/JsonLayout.java
@@ -889,7 +889,6 @@ public final class JsonLayout extends AbstractJacksonLayout {
* The header pattern, defaults to {@code "["} if null.
* @param footerPattern
* The header pattern, defaults to {@code "]"} if null.
- * @param footerPattern
* @param charset
* The character set to use, if {@code null}, uses "UTF-8".
* @return A JSON Layout.
[3/3] logging-log4j2 git commit: Fix layout documentation
Posted by mi...@apache.org.
Fix layout documentation
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/1285b1e2
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/1285b1e2
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/1285b1e2
Branch: refs/heads/master
Commit: 1285b1e2fe527b5e2f02dd258d0dccea593fcf8b
Parents: 99632fc
Author: Mikael St�ldal <mi...@magine.com>
Authored: Fri May 20 10:23:44 2016 +0200
Committer: Mikael St�ldal <mi...@magine.com>
Committed: Fri May 20 10:25:15 2016 +0200
----------------------------------------------------------------------
src/site/xdoc/manual/layouts.xml.vm | 92 ++++++++++++++++++++++++--------
1 file changed, 69 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/1285b1e2/src/site/xdoc/manual/layouts.xml.vm
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/layouts.xml.vm b/src/site/xdoc/manual/layouts.xml.vm
index 1a33b76..80b8dba 100644
--- a/src/site/xdoc/manual/layouts.xml.vm
+++ b/src/site/xdoc/manual/layouts.xml.vm
@@ -326,12 +326,6 @@ logger.debug("one={}, two={}, three={}", 1, 2, 3);
<p>
This approach enforces the independence of the JSONLayout and the appender where you embed it.
</p>
- <h4>Encoding</h4>
- <p>
- Appenders using this layout should have their <code>charset</code> set to <code>UTF-8</code> or
- <code>UTF-16</code>, otherwise events containing non-ASCII characters could result in corrupted log files.
- If not specified, this layout uses UTF-8.
- </p>
<h4>Pretty vs. compact JSON</h4>
<p>
By default, the JSON layout is not compact (a.k.a. not "pretty") with <code>compact="false"</code>, which
@@ -348,8 +342,8 @@ logger.debug("one={}, two={}, three={}", 1, 2, 3);
<tr>
<td>charset</td>
<td>String</td>
- <td>The character set to use when converting the HTML String to a byte array. The value must be
- a valid ${Charset}. If not specified, UTF-8 will be used.</td>
+ <td>The character set to use when converting to a byte array. The value must be a valid ${Charset}.
+ If not specified, UTF-8 will be used.</td>
</tr>
<tr>
<td>compact</td>
@@ -372,7 +366,7 @@ logger.debug("one={}, two={}, three={}", 1, 2, 3);
<tr>
<td>properties</td>
<td>boolean</td>
- <td>If true, the appender includes the thread context in the generated JSON. Defaults to false.</td>
+ <td>If true, the appender includes the thread context map in the generated JSON. Defaults to false.</td>
</tr>
<tr>
<td>locationInfo</td>
@@ -1848,12 +1842,6 @@ at org.apache.logging.log4j.core.pattern.ExtendedThrowableTest.testException(Ext
parent will be provided in the <code>parent</code> attribute of the <code>Marker</code> element.
Only the leaf marker is included, not the full hierarchy.
</p>
- <h4>Encoding</h4>
- <p>
- Appenders using this layout should have their <code>charset</code> set to <code>UTF-8</code> or
- <code>UTF-16</code>, otherwise events containing non ASCII characters could result in corrupted log files.
- If not specified, this layout uses UTF-8.
- </p>
<h4>Pretty vs. compact XML</h4>
<p>
By default, the XML layout is not compact (a.k.a. not "pretty") with <code>compact="false"</code>, which
@@ -1861,6 +1849,44 @@ at org.apache.logging.log4j.core.pattern.ExtendedThrowableTest.testException(Ext
<code>compact="true"</code>, then no end-of-line or indentation is used. Message content may contain,
of course, end-of-lines.
</p>
+ <table>
+ <tr>
+ <th>Parameter Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>charset</td>
+ <td>String</td>
+ <td>The character set to use when converting to a byte array. The value must be a valid ${Charset}.
+ If not specified, UTF-8 will be used.</td>
+ </tr>
+ <tr>
+ <td>compact</td>
+ <td>boolean</td>
+ <td>If true, the appender does not use end-of-lines and indentation. Defaults to false.</td>
+ </tr>
+ <tr>
+ <td>complete</td>
+ <td>boolean</td>
+ <td>If true, the appender includes the XML header and footer. Defaults to false.</td>
+ </tr>
+ <tr>
+ <td>properties</td>
+ <td>boolean</td>
+ <td>If true, the appender includes the thread context map in the generated XML. Defaults to false.</td>
+ </tr>
+ <tr>
+ <td>locationInfo</td>
+ <td>boolean</td>
+ <td>
+ <p>If true, the appender includes the location information in the generated XML. Defaults to false.</p>
+ <p>Generating <a href="#LocationInformation">location information</a>
+ is an expensive operation and may impact performance. Use with caution.</p>
+ </td>
+ </tr>
+ <caption align="top">XML Layout Parameters</caption>
+ </table>
</subsection>
<a name="YamlLayout"/>
<subsection name="YamlLayout">
@@ -2004,14 +2030,34 @@ source:
method: "createLogEvent"
file: "LogEventFixtures.java"
line: 53</pre>
- <p>
- This approach enforces the independence of the YamlLayout and the appender where you embed it.
- </p>
- <h4>Encoding</h4>
- <p>
- Appenders using this layout should have their {@code charset} set to {@code UTF-8} or {@code UTF-16}, otherwise
- events containing non ASCII characters could result in corrupted log files.
- </p>
+ <table>
+ <tr>
+ <th>Parameter Name</th>
+ <th>Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>charset</td>
+ <td>String</td>
+ <td>The character set to use when converting to a byte array. The value must be a valid ${Charset}.
+ If not specified, UTF-8 will be used.</td>
+ </tr>
+ <tr>
+ <td>properties</td>
+ <td>boolean</td>
+ <td>If true, the appender includes the thread context map in the generated YAML. Defaults to false.</td>
+ </tr>
+ <tr>
+ <td>locationInfo</td>
+ <td>boolean</td>
+ <td>
+ <p>If true, the appender includes the location information in the generated YAML. Defaults to false.</p>
+ <p>Generating <a href="#LocationInformation">location information</a>
+ is an expensive operation and may impact performance. Use with caution.</p>
+ </td>
+ </tr>
+ <caption align="top">YAML Layout Parameters</caption>
+ </table>
</subsection>
<a name="LocationInformation"/>
<subsection name="Location Information">