[glib] testutils: remove internal ABI comment
- From: Marc-Andre Lureau <malureau src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] testutils: remove internal ABI comment
- Date: Mon, 5 Oct 2015 13:33:35 +0000 (UTC)
commit dabf6627886c1d21b9fe03c897809eb64ef2ac54
Author: Marc-André Lureau <marcandre lureau gmail com>
Date: Mon Oct 5 13:02:37 2015 +0200
testutils: remove internal ABI comment
Some testutils external symbols are marked semi-internals, other
internals. It is not obvious what guarantees these symbols provide.
However, tests are now installable, and require the ABI stability
that glib provides for the rest of the symbols.
In my case, I would like to introduce g_assert* compat code for older
glib versions, and be able to use the so-called "internal" ABI.
I propose this change to the headers comments to explain the stability
guarantees. Removing the "internal" = you must not use this, in favor
of semi-internal = this is not documented.
https://bugzilla.gnome.org/show_bug.cgi?id=756077
glib/gtestutils.h | 7 +++++--
1 files changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/glib/gtestutils.h b/glib/gtestutils.h
index 3f56f0a..d788eb9 100644
--- a/glib/gtestutils.h
+++ b/glib/gtestutils.h
@@ -263,7 +263,11 @@ GLIB_AVAILABLE_IN_ALL
double g_test_rand_double_range (double range_start,
double range_end);
-/* semi-internal API */
+/*
+ * semi-internal API: non-documented symbols with stable ABI. You
+ * should use the non-internal helper macros instead. However, for
+ * compatibility reason, you may use this semi-internal API.
+ */
GLIB_AVAILABLE_IN_ALL
GTestCase* g_test_create_case (const char *test_name,
gsize data_size,
@@ -284,7 +288,6 @@ void g_test_suite_add_suite (GTestSuite *suite,
GLIB_AVAILABLE_IN_ALL
int g_test_run_suite (GTestSuite *suite);
-/* internal ABI */
GLIB_AVAILABLE_IN_ALL
void g_test_trap_assertions (const char *domain,
const char *file,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]