From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Tue, 11 Jul 2017 08:40:11 +0000 (-0400)
Subject: Add comments to log_functions which shouldn't be called from library code (#6326)
X-Git-Tag: v234~11
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e3e42fc2b52dbd284a56457269ca920d6ab46295;p=thirdparty%2Fsystemd.git

Add comments to log_functions which shouldn't be called from library code (#6326)
---

diff --git a/src/basic/log.c b/src/basic/log.c
index ab1e6cac1e8..3fd53800a09 100644
--- a/src/basic/log.c
+++ b/src/basic/log.c
@@ -232,6 +232,8 @@ fail:
 int log_open(void) {
         int r;
 
+        /* Do not call from library code. */
+
         /* If we don't use the console we close it here, to not get
          * killed by SAK. If we don't use syslog we close it here so
          * that we are not confused by somebody deleting the socket in
@@ -306,6 +308,8 @@ void log_set_target(LogTarget target) {
 }
 
 void log_close(void) {
+        /* Do not call from library code. */
+
         log_close_journal();
         log_close_syslog();
         log_close_kmsg();
@@ -313,6 +317,8 @@ void log_close(void) {
 }
 
 void log_forget_fds(void) {
+        /* Do not call from library code. */
+
         console_fd = kmsg_fd = syslog_fd = journal_fd = -1;
 }
 
@@ -1034,6 +1040,8 @@ static int parse_proc_cmdline_item(const char *key, const char *value, void *dat
 }
 
 void log_parse_environment_realm(LogRealm realm) {
+        /* Do not call from library code. */
+
         const char *e;
 
         if (get_ctty_devnr(0, NULL) < 0)
diff --git a/src/basic/log.h b/src/basic/log.h
index 57463fbb839..ff5d776b1d7 100644
--- a/src/basic/log.h
+++ b/src/basic/log.h
@@ -86,6 +86,11 @@ int log_get_max_level_realm(LogRealm realm) _pure_;
 #define log_get_max_level()                     \
         log_get_max_level_realm(LOG_REALM)
 
+/* Functions below that open and close logs or configure logging based on the
+ * environment should not be called from library code — this is always a job
+ * for the application itself.
+ */
+
 int log_open(void);
 void log_close(void);
 void log_forget_fds(void);