lib: add comments to exposed but internal symbols

These two functions, despite being exposed by the shared library, are
not part of the public ABI.  They are only meant to be used by the
Python plugin provider, which is conceptually part of libbabeltrace2,
but implemented as a separate shared library.  Add comments to explain
that.

Change-Id: I704240070403c9dd5d75f15e107c00b011d8a5ef
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2407
Tested-by: jenkins <jenkins@lttng.org>

diff --git a/src/lib/logging.h b/src/lib/logging.h
index 2c55f14f19f0d754ca8f7c8e45eb487d1535a5fb..f4890ce34f0a07c3211b1e0445e14e7d743c8e8a 100644 (file)
--- a/src/lib/logging.h
+++ b/src/lib/logging.h
@@ -64,6 +64,11 @@ int bt_lib_log_level;
  *
  * Use one of the BT_LIB_LOG*() macros above instead of calling this
  * function directly.
+ *
+ * This function would normally be BT_HIDDEN, but it is used by the Python
+ * plugin provider, which is conceptually part of libbabeltrace2, but
+ * implemented as a separate shared object, for modularity.  It is therefore
+ * exposed, but not part of the public ABI.
  */
 void bt_lib_log(const char *func, const char *file, unsigned line,
                int lvl, const char *tag, const char *fmt, ...);
@@ -93,6 +98,11 @@ void bt_lib_log(const char *func, const char *file, unsigned line,
  *
  * Use one of the BT_LIB_LOG*_APPEND_CAUSE() macros above instead of
  * calling this function directly.
+ *
+ * This function would normally be BT_HIDDEN, but it is used by the Python
+ * plugin provider, which is conceptually part of libbabeltrace2, but
+ * implemented as a separate shared object, for modularity.  It is therefore
+ * exposed, but not part of the ABI.
  */
 void bt_lib_maybe_log_and_append_cause(const char *func, const char *file,
                unsigned line, int lvl, const char *tag,