lib: add comment to bt_plugin_so_create_all_from_static

[babeltrace.git] / src / lib / plugin / plugin-so.h

diff --git a/src/lib/plugin/plugin-so.h b/src/lib/plugin/plugin-so.h
index 377fa0d298c56ba46396ad3139c925659d78ed13..be193d90b5918d1fc1b54a1373f870393faeaf94 100644 (file)
--- a/src/lib/plugin/plugin-so.h
+++ b/src/lib/plugin/plugin-so.h
@@ -26,6 +26,7 @@
 
 #include <glib.h>
 #include <gmodule.h>
+#include <stdbool.h>
 #include <babeltrace2/types.h>
 #include "common/macros.h"
 
@@ -39,7 +40,7 @@ struct bt_plugin_so_shared_lib_handle {
 
        /* True if initialization function was called */
        bt_bool init_called;
-       bt_plugin_exit_func exit;
+       bt_plugin_finalize_func exit;
 };
 
 struct bt_plugin_so_spec_data {
@@ -60,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);