qos-ch / logback

The reliable, generic, fast and flexible logging framework for Java.
http://logback.qos.ch
Other
2.97k stars 1.28k forks source link

Incorrect system property name in documentation (logback.serializedModelFile vs logback.scmoFile) #782

Closed bbobcik closed 6 months ago

bbobcik commented 6 months ago

LogBack version: 1.5.0

The documentation states that property name for serialized configuration file location is logback.serializedModelFile link, step 2.

However, as part of commit https://github.com/qos-ch/logback/commit/f4fe391405c44d42ae725245602074038d1d4307, the property name was changed to logback.scmoFile. I feel that change was beyond the intended typo fix, or at least wasn't accompanied with appropriate documentation change.

Steps to reproduce:

  1. Prepare serialized configuration file logback.scmo and place it into the current directory
  2. Invoke Java application with java -Dlogback.serializedModelFile=./logback.scmo -jar test_application.jar ...
  3. Observe that the serialized configuration file was not picked

Steps to mitigate:

  1. As before
  2. Invoke Java application with java -Dlogback.scmoFile=./logback.scmo -jar test_application.jar ...
  3. Observe that the serialized configuration file was applied as expected
ceki commented 6 months ago

@bbobcik Thank you for this detailed report. Documentation fixed.