search

ral-facilities / ids.r2dfoo

The server component of the ICAT Data Service
Other
0 stars 0 forks source link

Description of logback.xml property needs correcting #11

Open kevinphippsstfc opened 10 months ago

kevinphippsstfc commented 10 months ago

In the installation file (installation.xhtml.vm) the description of the logback.xml property says "The file ids.logback.xml.example may be renamed to ids.logback.xml to get started” but the file is actually called logback.xml.example and can be renamed to logback.xml.

I'm not actually sure this property works. Sam Hough in Diamond had problems with the property and asked me about it which alerted me to the error in the documentation. So possibly this property needs removing from the documentation and instead have a sentence in the instructions telling you to rename the file if you want to use it.

kevinphippsstfc commented 10 months ago

Looking into this a bit further, there is no code to handle a logback.xml property in the PropertyHandler (or anywhere else in the java code). The only place the file is handled is in the setup script where if a file named logback.xml is found then it is added to the WEB-INF/classes directory of the jar to be deployed.

Therefore I think the correct thing to do is to remove the documentation of the property in the run.properties file and add a sentence to the instructions saying to rename the file if you want to use it.