Rename `BT_PLUGIN_EXIT` to `BT_PLUGIN_FINALIZE`

Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: I5ac769f400d27688d97235db15d89a6c1c6e1ecb
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2104
Tested-by: jenkins <jenkins@lttng.org>
Reviewed-by: Philippe Proulx <eeppeliteloop@gmail.com>

diff --git a/include/babeltrace2/plugin/plugin-dev.h b/include/babeltrace2/plugin/plugin-dev.h
index 338423bcfa8cd5c2b0bfdb6bb8b3e3ddbdb62b1c..0dbe773814bf087a54208858dab5b54360d82022 100644 (file)
--- a/include/babeltrace2/plugin/plugin-dev.h
+++ b/include/babeltrace2/plugin/plugin-dev.h
@@ -68,7 +68,7 @@ typedef bt_plugin_initialize_func_status (*bt_plugin_initialize_func)(
                bt_self_plugin *plugin);
 
 /* Plugin exit function type */
-typedef void (*bt_plugin_exit_func)(void);
+typedef void (*bt_plugin_finalize_func)(void);
 
 /* Plugin descriptor: describes a single plugin (internal use) */
 struct __bt_plugin_descriptor {
@@ -117,7 +117,7 @@ struct __bt_plugin_descriptor_attribute {
                bt_plugin_initialize_func init;
 
                /* BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_EXIT */
-               bt_plugin_exit_func exit;
+               bt_plugin_finalize_func exit;
 
                /* BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_AUTHOR */
                const char *author;
@@ -471,9 +471,9 @@ struct __bt_plugin_component_class_descriptor_attribute const * const *__bt_get_
  * plugin descriptor.
  *
  * _id: Plugin descriptor ID (C identifier).
- * _x:  Exit function (bt_plugin_exit_func).
+ * _x:  Exit function (bt_plugin_finalize_func).
  */
-#define BT_PLUGIN_EXIT_WITH_ID(_id, _x) \
+#define BT_PLUGIN_FINALIZE_WITH_ID(_id, _x) \
        __BT_PLUGIN_DESCRIPTOR_ATTRIBUTE(exit, BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_EXIT, _id, _x)
 
 /*
@@ -1015,9 +1015,9 @@ struct __bt_plugin_component_class_descriptor_attribute const * const *__bt_get_
  * Defines a plugin exit function attribute attached to the automatic
  * plugin descriptor.
  *
- * _x: Exit function (bt_plugin_exit_func).
+ * _x: Exit function (bt_plugin_finalize_func).
  */
-#define BT_PLUGIN_EXIT(_x)             BT_PLUGIN_EXIT_WITH_ID(auto, _x)
+#define BT_PLUGIN_FINALIZE(_x)                 BT_PLUGIN_FINALIZE_WITH_ID(auto, _x)
 
 /*
  * Defines an author attribute attached to the automatic plugin

diff --git a/src/lib/plugin/plugin-so.h b/src/lib/plugin/plugin-so.h
index 377fa0d298c56ba46396ad3139c925659d78ed13..88c52e99772f3048cc8718e1da22d11d146677e7 100644 (file)
--- a/src/lib/plugin/plugin-so.h
+++ b/src/lib/plugin/plugin-so.h
@@ -39,7 +39,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 {

diff --git a/tests/lib/plugin.c b/tests/lib/plugin.c
index 74c185c5fd94eaac1bd4a4f17b9dbee656a60982..d5a21808fbbfdda25c4176525f7600c562c25484 100644 (file)
--- a/tests/lib/plugin.c
+++ b/tests/lib/plugin.c
@@ -42,7 +42,7 @@ static int check_env_var(const char *name)
 static void reset_test_plugin_env_vars(void)
 {
        g_setenv("BT_TEST_PLUGIN_INITIALIZE_CALLED", "0", 1);
-       g_setenv("BT_TEST_PLUGIN_EXIT_CALLED", "0", 1);
+       g_setenv("BT_TEST_PLUGIN_FINALIZE_CALLED", "0", 1);
 }
 
 static char *get_test_plugin_path(const char *plugin_dir,
@@ -105,8 +105,8 @@ static void test_minimal(const char *plugin_dir)
        ok(bt_plugin_get_sink_component_class_count(plugin) == 0,
                "bt_plugin_get_sink_component_class_count() returns the expected value");
        bt_plugin_set_put_ref(plugin_set);
-       ok(check_env_var("BT_TEST_PLUGIN_EXIT_CALLED") == 1,
-               "plugin's exit function is called when the plugin is destroyed");
+       ok(check_env_var("BT_TEST_PLUGIN_FINALIZE_CALLED") == 1,
+               "plugin's finalize function is called when the plugin is destroyed");
 
        free(minimal_path);
 }

diff --git a/tests/lib/test-plugin-plugins/minimal.c b/tests/lib/test-plugin-plugins/minimal.c
index a6ba68e61638ac65d77f25846e3f59ed7eb5db13..661c7528490b0966111aed9f0fef7409bcb5790c 100644 (file)
--- a/tests/lib/test-plugin-plugins/minimal.c
+++ b/tests/lib/test-plugin-plugins/minimal.c
@@ -25,9 +25,9 @@ static bt_plugin_initialize_func_status plugin_init(bt_self_plugin *plugin)
        return BT_PLUGIN_INITIALIZE_FUNC_STATUS_OK;
 }
 
-static void plugin_exit(void)
+static void plugin_finalize(void)
 {
-       g_setenv("BT_TEST_PLUGIN_EXIT_CALLED", "1", 1);
+       g_setenv("BT_TEST_PLUGIN_FINALIZE_CALLED", "1", 1);
 }
 
 BT_PLUGIN_MODULE();
@@ -36,4 +36,4 @@ BT_PLUGIN_DESCRIPTION("Minimal Babeltrace plugin with no component classes");
 BT_PLUGIN_AUTHOR("Janine Sutto");
 BT_PLUGIN_LICENSE("Beerware");
 BT_PLUGIN_INITIALIZE(plugin_init);
-BT_PLUGIN_EXIT(plugin_exit);
+BT_PLUGIN_FINALIZE(plugin_finalize);