logback icon indicating copy to clipboard operation
logback copied to clipboard

SizeAndTimeBasedFNATP was renamed but is still mentionned in the documentation

Open guilgaly opened this issue 5 months ago • 4 comments

In the latest release (1.5.8), SizeAndTimeBasedFNATP was renamed to SizeAndTimeBasedFileNamingAndTriggeringPolicy (in this commit).

However:

  • The documentation, in the Appenders chapter, mentions that SizeAndTimeBasedFNATP should still work although it's no longer recommended.

    In versions prior to 1.1.7, this document mentioned a component called SizeAndTimeBasedFNATP. However, given that SizeAndTimeBasedRollingPolicy offers a simpler configuration structure, we no longer document SizeAndTimeBasedFNATP. Nevertheless, earlier configuration files using SizeAndTimeBasedFNATP will continue to work just fine. In fact, SizeAndTimeBasedRollingPolicy is implemented with a SizeAndTimeBasedFNATP subcomponent.

  • The constant CoreConstants.SIZE_AND_TIME_BASED_FNATP_IS_DEPRECATED, still mentions the name SizeAndTimeBasedFNATP in a deprecation warning in case of direct usage of SizeAndTimeBasedFileNamingAndTriggeringPolicy.

By the way, the name SizeAndTimeBasedFNATP still also appears in various places in the code, but those aren't user-visible.

I guess that either SizeAndTimeBasedFNATP shouldn't have been renamed (if its direct use is still supposed to work, although deprecated), or the documentation should be updated.

guilgaly avatar Sep 10 '24 08:09 guilgaly