Add gentle deprecation to debug_log_message

[eileenmcnaughton]

Overview

Add gentle deprecation to debug_log_message

Before

Civi::log() is preferred but how would people have known?

After

Marked as deprecated, I added some docs https://docs.civicrm.org/dev/en/latest/framework/logging/

Technical Details

Comments

[civibot]

(Standard links)

• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[demeritcowboy]

But civi::log->X() calls debug_log_message - am I missing something?

[eileenmcnaughton]

@demeritcowboy yeah - it does - unless people use (e.g) monolog to change that - but hopefully this will encourage every other function to go via Civi::log

[demeritcowboy]

Would @internal be closer to what is happening?

[demeritcowboy]

I'm being too picky here. It's just there's a large amount of extension code that uses this. There's still a large amount that uses CRM_Core_BAO_Setting::getItem.

[eileenmcnaughton]

@demeritcowboy yeah I guess what we would ideally do is change the order to debug_info calls Civi::log rather than vice versa - but I think this is just intended to be a low-level nudge without getting too cosy with Peter & Bugs