[jira] [Resolved] (LOG4J2-759) Minor documentation issues

["Remko Popma (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/LOG4J2-759?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Remko Popma resolved LOG4J2-759.
--------------------------------

    Resolution: Fixed
      Assignee: Remko Popma

Converted JMX manual page and Custom Log Levels page to Velocity template to automatically use project version in command syntax (revision 1615889).  Updated change log in revision 1615891.

> Minor documentation issues
> --------------------------
>
>                 Key: LOG4J2-759
>                 URL: https://issues.apache.org/jira/browse/LOG4J2-759
>             Project: Log4j 2
>          Issue Type: Improvement
>    Affects Versions: 2.0.1
>            Reporter: Remko Popma
>            Assignee: Remko Popma
>             Fix For: 2.1
>
>
> Below is a list of minor issues found with the site during the review for the 2.0.1 release.
> Project Info > Dependency Convergence: logj2-perf uses disruptor-3.2.1, but log4j-core uses disruptor-3.3.0.
> (Not an issue since log4j-perf is not a distribution artifact.)
> Javadoc: many package docs mention "Log4j 2.0". E.g.
> http://people.apache.org/~mattsicker/log4j/2.0.1/log4j-api/apidocs/index.html
> Sometime in the future we will release version 2.1, 2.2, etc.
> Should we update all Javadoc pages to "Log4j 2" to future-proof them?
> Similarly, the FAQ page mentions "the Log4j 2.0 implementation" and "the Log4j 2.0 API". We should probably change this to "the Log4j 2 implementation" and "the Log4j 2 API".
> Manual > Introduction (index.html)
> "The latest log4j version, including full-source code, class files and 
>  documentation can be found at http://logging.apache.org/log4j/2.0/index.html."
> -> We should change that link to http://logging.apache.org/log4j/2.x/index.html
>    (It looks like 2.0 and 2.x both work as URLs.)
> Manual > Log4j 1.x Migration also has a few mentions of "2.0".
> Manual > Configuration page has one mention of "2.0".
> Manual > JMX has six places where log4j-api-2.0.jar etc are mentioned. 
> 		-> Can we make these variables to they change with the ${project.version}?
> Manual > Custom Log Levels has two places where log4j-core.2.0.jar is mentioned.
> 		-> Can we make these variables to they change with the ${project.version}?
> Manual > Layouts > PatternLayout, %d pattern examples:
> {{%d\{HH:mm:ss\}\{GMT+0\}}}	{{18:34:02,781}} <- this does not look right? The result has millis instead of timezone...
> Manual > Architecture > LoggerConfig > Log Levels: (we may want to rewrite the text below)
> The set of possible levels includes TRACE, DEBUG, INFO, WARN, ERROR, and FATAL.
> Note that in Log4j 2, the Level is an Enum and cannot be sub-classed.
> Users who desire more granularity are encouraged to use Markers instead.
> Manual > Extending Log4j > ContextSelector: missing AsyncLoggerContextSelector



--
This message was sent by Atlassian JIRA
(v6.2#6252)

---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-dev-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-dev-help@logging.apache.org