lib: add comment to bt_plugin_so_create_all_from_static

This symbol would normally not be exposed, but it is used from the
Python plugin provider, which is conceptually part of libbabeltrace2,
but implemented as a separate shared library.  Add a comment to explain
that.

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

diff --git a/src/lib/plugin/plugin-so.h b/src/lib/plugin/plugin-so.h
index b9d0499642c5272c34c0cf278407a010b4c0d341..be193d90b5918d1fc1b54a1373f870393faeaf94 100644 (file)
--- a/src/lib/plugin/plugin-so.h
+++ b/src/lib/plugin/plugin-so.h
@@ -61,6 +61,12 @@ BT_HIDDEN
 int bt_plugin_so_create_all_from_static(bool fail_on_load_error,
                struct bt_plugin_set **plugin_set_out);
 
+/*
+ * 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_plugin_so_on_add_component_class(struct bt_plugin *plugin,
                struct bt_component_class *comp_class);