Skip to content

Fix Log4j1SyslogLayout builder javadoc attributes - #4239

Open
kalayciburak wants to merge 1 commit into
apache:2.xfrom
kalayciburak:fix/log4j1-syslog-layout-javadoc
Open

Fix Log4j1SyslogLayout builder javadoc attributes#4239
kalayciburak wants to merge 1 commit into
apache:2.xfrom
kalayciburak:fix/log4j1-syslog-layout-javadoc

Conversation

@kalayciburak

Copy link
Copy Markdown

What

Log4j1SyslogLayout.Builder javadoc listed includeNewLine and escapeNL, which were copy-pasted from org.apache.logging.log4j.core.layout.SyslogLayout and are not implemented on this layout.

Changes

  • Document the builder attributes that actually exist: facility, facilityPrinting, header, messageLayout, and charset
  • Note that includeNewLine / escapeNL are not supported on this layout

Test

  • Source review against builder fields and toSerializable()
  • Module previously compiled Log4j1SyslogLayout after the edit (javadoc-only change)

Fixes #4237

Remove copy-pasted includeNewLine/escapeNL docs from SyslogLayout and
document the attributes this builder actually exposes.

Fixes apache#4237

Signed-off-by: Burak KALAYCI <kalayciburak1996@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

Log4j1SyslogLayout javadoc documents a non-existent escapeNL option

1 participant