Log4j 2
  1. Log4j 2
  2. LOG4J2-699

PatternLayout manual page missing documentation on header/footer

        Details

        • Type: Documentation Documentation
        • Status: Closed
        • Priority: Major Major
        • Resolution: Fixed
        • Affects Version/s: 2.0-rc2
        • Fix Version/s: 2.0
        • Component/s: Documentation
        • Labels:
          None

          Description

          PatternLayout manual page does not mention that this layout supports headers and footers.

          http://logging.apache.org/log4j/2.x/manual/layouts.html#PatternLayout

          Documented parameters:

          • charset
          • pattern
          • replace
          • alwaysWriteExceptions

          Undocumented parameters:

          • config
          • noConsoleNoAnsi
          • header
          • footer

          I'm thinking to only document the header and footer parameters, but should the others be documented also?

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            Ralph Goers added a comment -

            Config is not really a user configurable parameter. It is inserted by the configuration processor.

            Show
            Ralph Goers added a comment - Config is not really a user configurable parameter. It is inserted by the configuration processor.
            Hide
            Permalink
            Remko Popma added a comment - - edited

            Fixed in revision 1608193.

            Note: I didn't add documentation for noConsoleNoAnsi, because although I can tell the intention from the name and the javadoc, I could not find if/where it was implemented.

            Show
            Remko Popma added a comment - - edited Fixed in revision 1608193. Note: I didn't add documentation for noConsoleNoAnsi , because although I can tell the intention from the name and the javadoc, I could not find if/where it was implemented.
            Hide
            Permalink
            Gary Gregory added a comment -

            noConsoleNoAnsi is an obscure setting, granted, but it is implemented in org.apache.logging.log4j.core.pattern.StyleConverter. If you search all Java files for noConsoleNoAnsi, you'll find three files that reference it.

            Show
            Gary Gregory added a comment - noConsoleNoAnsi is an obscure setting, granted, but it is implemented in org.apache.logging.log4j.core.pattern.StyleConverter . If you search all Java files for noConsoleNoAnsi , you'll find three files that reference it.
            Hide
            Permalink
            Remko Popma added a comment -

            Thank you! I'll take a look and update the docs.

            Show
            Remko Popma added a comment - Thank you! I'll take a look and update the docs.
            Hide
            Permalink
            Remko Popma added a comment -

            Added documentation for noConsoleNoAnsi to manual page in revision 1608198.

            Show
            Remko Popma added a comment - Added documentation for noConsoleNoAnsi to manual page in revision 1608198.
            Hide
            Permalink
            Matt Sicker added a comment -

            Can confirm updated site has docs.

            Show
            Matt Sicker added a comment - Can confirm updated site has docs.

              People

              • Assignee:
                Remko Popma
                Reporter:
                Remko Popma
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Development