I just did that, didn't I?
On 2017-06-28 18:57, Gary Gregory wrote:
On Jun 28, 2017 08:54, "Matt Sicker" <[email protected]> wrote:
You can add a @deprecated javadoc tag to specify that which makes it more
prominent in the javadocs.
+1
Gary
On 28 June 2017 at 08:50, <[email protected]> wrote:
Repository: logging-log4j2
Updated Branches:
refs/heads/LOG4J2-1958 041f42dad -> 61db8afdd
LOG4J2-1958 Specify version when SerializedLayout is deprecated
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/
commit/61db8afd
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/61db8afd
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/61db8afd
Branch: refs/heads/LOG4J2-1958
Commit: 61db8afdd2761e83541095a5a964f4bddd6ac943
Parents: 041f42d
Author: Mikael Ståldal <[email protected]>
Authored: Wed Jun 28 15:50:28 2017 +0200
Committer: Mikael Ståldal <[email protected]>
Committed: Wed Jun 28 15:50:28 2017 +0200
----------------------------------------------------------------------
.../org/apache/logging/log4j/core/layout/SerializedLayout.java | 1 +
src/site/xdoc/manual/appenders.xml | 4 +++-
src/site/xdoc/manual/layouts.xml.vm | 6 +++---
3 files changed, 7 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/
61db8afd/log4j-core/src/main/java/org/apache/logging/log4j/
core/layout/SerializedLayout.java
----------------------------------------------------------------------
diff --git a/log4j-core/src/main/java/org/apache/logging/log4j/core/
layout/SerializedLayout.java
b/log4j-core/src/main/java/org/apache/logging/log4j/core/
layout/SerializedLayout.java
index 43700e0..091e31e 100644
--- a/log4j-core/src/main/java/org/apache/logging/log4j/core/
layout/SerializedLayout.java
+++ b/log4j-core/src/main/java/org/apache/logging/log4j/core/
layout/SerializedLayout.java
@@ -32,6 +32,7 @@ import org.apache.logging.log4j.core.
config.plugins.PluginFactory;
*
* @deprecated Java Serialization has inherent security weaknesses, using
this layout is no longer recommended.
* An alternative layout containing the same information is {@link
JsonLayout} when configured with properties="true".
+ * Deprecated since 2.9.
*/
@Deprecated
@Plugin(name = "SerializedLayout", category = Node.CATEGORY, elementType
= Layout.ELEMENT_TYPE, printObject = true)
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/
61db8afd/src/site/xdoc/manual/appenders.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/appenders.xml b/src/site/xdoc/manual/
appenders.xml
index 7d9dfc4..528dabe 100644
--- a/src/site/xdoc/manual/appenders.xml
+++ b/src/site/xdoc/manual/appenders.xml
@@ -1296,6 +1296,7 @@ public class ConnectionFactory {
<td>Layout</td>
<td>
The Layout to use to format the LogEvent. Required, there
is no default.
+ <em>New since 2.9, in previous versions SerializedLayout
was default.</em>
</td>
</tr>
<tr>
@@ -4380,7 +4381,8 @@ public class JpaLogEntity extends
AbstractLogEventWrapperEntity {
<tr>
<td>layout</td>
<td>Layout</td>
- <td>The Layout to use to format the LogEvent. Required,
there is no default.</td>
+ <td>The Layout to use to format the LogEvent. Required,
there is no default.
+ <em>New since 2.9, in previous versions
SerializedLayout was default.</em></td>
</tr>
<tr>
<td>reconnectionDelayMillis</td>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/
61db8afd/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 7d17fd1..a8353bd 100644
--- a/src/site/xdoc/manual/layouts.xml.vm
+++ b/src/site/xdoc/manual/layouts.xml.vm
@@ -1978,9 +1978,9 @@ at org.apache.logging.log4j.core.
pattern.ExtendedThrowableTest.testException(Ext
The SerializedLayout accepts no parameters.
</p>
<p>
- Java Serialization has inherent security weaknesses, using this
layout is no longer recommended.
- An alternative layout containing the same information is <a
href="#JSONLayout">JsonLayout</a>,
- when configured with <code>properties="true"</code>.
+ This layout is deprecated since version 2.9. Java Serialization
has inherent security weaknesses,
+ using this layout is no longer recommended. An alternative
layout containing the same information
+ is <a href="#JSONLayout">JsonLayout</a>, configured with
<code>properties="true"</code>.
</p>
</subsection>
<a name="SyslogLayout"/>
--
Matt Sicker <[email protected]>
