lib: add comment about why `bt_lib_log_level` is exported
[babeltrace.git] / src / lib / logging.c
index 30ab704abd774b52a4b965c684e4c62c9f592870..8f3160b5ffa635abaad5a78b4a2dbeb576eb0483 100644 (file)
@@ -24,8 +24,8 @@
 #include <babeltrace2/logging.h>
 #include <babeltrace2/version.h>
 
-#define BT_LOG_TAG "LIB"
-#include "lib/lib-logging.h"
+#define BT_LOG_TAG "LIB/LOGGING"
+#include "lib/logging.h"
 
 #ifdef BT_DEV_MODE
 /*
  * In non-developer mode, use NONE by default: we don't print logging
  * statements for any executable which links with the library. The
  * executable must call bt_logging_set_global_level() or the
- * executable's user must set the BABELTRACE_LOGGING_GLOBAL_LEVEL
+ * executable's user must set the `LIBBABELTRACE2_INIT_LOG_LEVEL`
  * environment variable to enable logging.
  */
 # define DEFAULT_LOG_LEVEL     BT_LOG_NONE
 #endif /* BT_DEV_MODE */
 
+/*
+ * This is exported because even though the Python plugin provider is a
+ * different shared object for packaging purposes, it's still considered
+ * part of the library and therefore needs the library's run-time log
+ * level.
+ */
 int bt_lib_log_level = DEFAULT_LOG_LEVEL;
 
 enum bt_logging_level bt_logging_get_minimal_level(void)
@@ -79,7 +85,7 @@ void __attribute__((constructor)) bt_logging_ctor(void)
                "";
 
        bt_logging_set_global_level(
-               bt_log_get_level_from_env("BABELTRACE_LOGGING_GLOBAL_LEVEL"));
+               bt_log_get_level_from_env("LIBBABELTRACE2_INIT_LOG_LEVEL"));
        BT_LOGI("Babeltrace %d.%d.%d%s library loaded: "
                "major=%d, minor=%d, patch=%d, extra=\"%s\"",
                bt_version_get_major(), bt_version_get_minor(),
This page took 0.02432 seconds and 4 git commands to generate.