You are viewing a plain text version of this content. The canonical link for it is here.
Posted to log4j-dev@logging.apache.org by "Ralph Goers (JIRA)" <ji...@apache.org> on 2015/11/07 13:03:10 UTC

[jira] [Comment Edited] (LOG4J2-1194) documentation does not match parameters for at least one Appender

    [ https://issues.apache.org/jira/browse/LOG4J2-1194?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14995174#comment-14995174 ] 

Ralph Goers edited comment on LOG4J2-1194 at 11/7/15 12:02 PM:
---------------------------------------------------------------

I'm not sure why you are using "nice looking" and "ugly". 

You also can't really tell anything by looking at the javadoc method summary. You must look at the method detail.

The parameter names you use in the configuration do not match the parameter names in the code. They match the values specified in the annotations specified on the parameters. Unfortunately those still don't match.  The manual specifies loggerName and LevelPair while the code uses logger and KeyValuePair.

While I like the names in the manual better, changing the code to match the manual will break compatibility, so the manual has to be updated to match the code.


was (Author: ralph.goers@dslextreme.com):
I'm not sure why you are using "nice looking" and "ugly". 

You also can't really tell anything by looking at the javadoc. The parameter names you use in the configuration do not match the parameter names in the code. They match the values specified in the annotations specified on the parameters. Unfortunately those still don't match.  The manual specifies loggerName and LevelPair while the code uses logger and KeyValuePair.

While I like the names in the manual better, changing the code to match the manual will break compatibility, so the manual has to be updated to match the code.

> documentation does not match parameters for at least one Appender
> -----------------------------------------------------------------
>
>                 Key: LOG4J2-1194
>                 URL: https://issues.apache.org/jira/browse/LOG4J2-1194
>             Project: Log4j 2
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 2.4.1
>            Reporter: adam brin
>
> I've been trying to configure the LoggerNameLevelRewriteFilter based on the documentation: 
> https://logging.apache.org/log4j/2.x/manual/appenders.html
> but, the parameters in the doc, don't match the parameters in the JavaDoc:
> https://logging.apache.org/log4j/2.x/log4j-core/apidocs/org/apache/logging/log4j/core/appender/rewrite/LoggerNameLevelRewritePolicy.html
> Based on the error messages, it seems like the JavaDoc parameters are correct.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

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