This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
The following commit(s) were added to refs/heads/2.x by this push:
new 668c0ccaa3 Fix Log4j1SyslogLayout builder javadoc attributes (#4239)
668c0ccaa3 is described below
commit 668c0ccaa358b1afa4b5fcaa8004370a0fa95c7c
Author: Burak Kalaycı <[email protected]>
AuthorDate: Thu Aug 27 13:12:58 2026 +0300
Fix Log4j1SyslogLayout builder javadoc attributes (#4239)
Signed-off-by: Burak KALAYCI <[email protected]>
---
.../main/java/org/apache/log4j/layout/Log4j1SyslogLayout.java | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
diff --git
a/log4j-1.2-api/src/main/java/org/apache/log4j/layout/Log4j1SyslogLayout.java
b/log4j-1.2-api/src/main/java/org/apache/log4j/layout/Log4j1SyslogLayout.java
index 4a3dcc1162..6545418529 100644
---
a/log4j-1.2-api/src/main/java/org/apache/log4j/layout/Log4j1SyslogLayout.java
+++
b/log4j-1.2-api/src/main/java/org/apache/log4j/layout/Log4j1SyslogLayout.java
@@ -49,14 +49,19 @@ import org.apache.logging.log4j.util.Chars;
public final class Log4j1SyslogLayout extends AbstractStringLayout {
/**
- * Builds a SyslogLayout.
+ * Builds a {@link Log4j1SyslogLayout}.
* <p>The main arguments are</p>
* <ul>
* <li>facility: The Facility is used to try to classify the message.</li>
- * <li>includeNewLine: If true a newline will be appended to the
result.</li>
- * <li>escapeNL: Pattern to use for replacing newlines.</li>
+ * <li>facilityPrinting: If true the facility name is included in the
message.</li>
+ * <li>header: If true a header with local host name and timestamp is
included.</li>
+ * <li>messageLayout: Optional layout used to render the message body.</li>
* <li>charset: The character set.</li>
* </ul>
+ * <p>
+ * Unlike {@link org.apache.logging.log4j.core.layout.SyslogLayout}, this
layout does not support
+ * {@code includeNewLine} or {@code escapeNL} options.
+ * </p>
* @param <B> the builder type
*/
public static class Builder<B extends Builder<B>> extends
AbstractStringLayout.Builder<B>
