[jira] [Commented] (SLING-7588) LogManager configuration property description out of sync with implementation

["Carsten Ziegeler (JIRA)" <ji...@apache.org>]

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

Carsten Ziegeler commented on SLING-7588:
-----------------------------------------

[~jsedding] Sounds good to me, I think it makes sense to have date/time control in addition to a maximum of files. I haven't looked at the description of the date/time property, maybe it needs to be adjusted as well?

> LogManager configuration property description out of sync with implementation
> -----------------------------------------------------------------------------
>
>                 Key: SLING-7588
>                 URL: https://issues.apache.org/jira/browse/SLING-7588
>             Project: Sling
>          Issue Type: Improvement
>          Components: Commons
>    Affects Versions: Commons Log 5.1.4
>            Reporter: Julian Sedding
>            Assignee: Julian Sedding
>            Priority: Minor
>
> In the metatype of LogManager {{org.apache.sling.commons.log.file.number}} currently is
> {code:java}The number of log files to keep. When the threshold of the log file reaches the configured maximum (see Log File Threshold), the log file is copied and a new log file is created. This setting specifies how many generations (incl. the active log file) should be kept. This is a positive numeric value. The default value is 5. This property is ignored if the Log File Threshold property specifies time/date controlled log file rotation.
> {code}
> The part about the property being ignored "This property is ignored if the Log File Threshold property specifies time/date controlled log file rotation." does not match the implementation.
> Based on my understanding of reading the source, I suggest to adjust the description to the following:
> {code:java}The number of log files to keep. When the threshold of the log file reaches the configured maximum (see Log File Threshold), the log file is copied and a new log file is created. This setting specifies how many generations (incl. the active log file) should be kept. This is a positive numeric value. The default value is 5. If the Log File Threshold property specifies time/date controlled log file rotation, log file deletion can be disabled by setting the number of log files to '0'.
> {code}
> cc [~chetanm], [~cziegeler]



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)