debug Explain the behaviour of setup_logging() more clearly

[sfrench/samba-autobuild/.git] / source3 / lib / debug.c

diff --git a/source3/lib/debug.c b/source3/lib/debug.c
index 026616babf5e1068d06d05c21c3781d64d1071e8..f9f4cae000b1c7994a57cfd46a8dfae021f23733 100644 (file)
--- a/source3/lib/debug.c
+++ b/source3/lib/debug.c
@@ -564,6 +564,12 @@ void debug_register_msgs(struct messaging_context *msg_ctx)
 /**
   control the name of the logfile and whether logging will be to stdout, stderr
   or a file, and set up syslog
+
+  new_log indicates the destination for the debug log (an enum in
+  order of precedence - once set to DEBUG_FILE, it is not possible to
+  reset to DEBUG_STDOUT for example.  This makes it easy to override
+  for debug to stderr on the command line, as the smb.conf cannot
+  reset it back to file-based logging
 */
 void setup_logging(const char *prog_name, enum debug_logtype new_logtype)
 {