From ddccb6ced58597e8250410a3912b60c1b5a2c0fa Mon Sep 17 00:00:00 2001 From: Simon Marchi Date: Tue, 19 Nov 2019 12:07:22 -0500 Subject: [PATCH] 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 Reviewed-on: https://review.lttng.org/c/babeltrace/+/2407 Tested-by: jenkins --- src/lib/logging.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/lib/logging.h b/src/lib/logging.h index 2c55f14f..f4890ce3 100644 --- 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, -- 2.34.1