log: add brief comment for log_set_open_when_needed() and log_set_always_reopen_console()

These two deserve some explanation...
2018-01-24 18:22:56 +01:00
parent d075092f14
commit 7a3be263d2
1 changed files with 5 additions and 0 deletions
@@ -304,7 +304,12 @@ void log_received_signal(int level, const struct signalfd_siginfo *si);

 /* If turned on, any requests for a log target involving "syslog" will be implicitly upgraded to the equivalent journal target */
 void log_set_upgrade_syslog_to_journal(bool b);
+
+/* If turned on, and log_open() is called, we'll not use STDERR_FILENO for logging ever, but rather open /dev/console */
 void log_set_always_reopen_console(bool b);
+
+/* If turned on, we'll open the log stream implicitly if needed on each individual log call. This is normally not
+ * desired as we want to reuse our logging streams. It is useful however  */
 void log_set_open_when_needed(bool b);

 /* If turned on, then we'll never use IPC-based logging, i.e. never log to syslog or the journal. We'll only log to