debug Explain the behaviour of setup_logging() more clearly
[sfrench/samba-autobuild/.git] / lib / util / debug.c
index 5760a709ef5772f7cdf4d460a44007bdce3e440e..54e7a5fcf6b9d0833f57f247ee0f76df21f297b4 100644 (file)
@@ -190,7 +190,13 @@ void debug_setup_talloc_log(void)
 
 /**
   control the name of the logfile and whether logging will be to stdout, stderr
 
 /**
   control the name of the logfile and whether logging will be to stdout, stderr
-  or a file
+  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
 */
 _PUBLIC_ void setup_logging(const char *prog_name, enum debug_logtype new_logtype)
 {
 */
 _PUBLIC_ void setup_logging(const char *prog_name, enum debug_logtype new_logtype)
 {