core: Move NS_LOG_FUNCTION to lowest priority

Tom Hendersonrequested to merge
tomhenderson/ns-3-dev:logging-policy into master

Spinout of discussion threads on !2816

  • move NS_LOG_FUNCTION to most verbose level
  • clarify differentiation between NS_LOG_LOGIC and NS_LOG_DEBUG
  • clarify that NS_LOG_FUNCTION should be omitted in constructors and destructors if called frequently

Also:

  • provide pointer in AGENTS.md for agents to find logging guidance
  • suggest to add NS_LOG_INFO statements around trace source invocations

If we go forward with this, this MR should be extended by auditing documentation to see whether any changes to documented output needs to be made. <-- Now done

Edited by Tom Henderson

Merge request reports