luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-10 11:26:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

gtestutils: Clarify docs about calling g_test_init() before anything

Browse Source 
Signed-off-by: Philip Withnall <pwithnall@endlessos.org>

Fixes: #2943
This commit is contained in:
Philip Withnall 2023-03-17 11:03:09 +00:00
parent 7fec23ed5e
commit 045bc7adde
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
glib/gtestutils.c
View File

@ -89,11 +89,15 @@
* The API is designed to handle creation and registration of test suites
* and test cases implicitly. A simple call like
* |[<!-- language="C" -->
* g_test_init (&argc, &argv, G_TEST_OPTION_ISOLATE_DIRS, NULL);
*
* g_test_add_func ("/misc/assertions", test_assertions);
* ]|
* creates a test suite called "misc" with a single test case named
* "assertions", which consists of running the test_assertions function.
*
* g_test_init() should be called before calling any other test functions.
*
* In addition to the traditional g_assert_true(), the test framework provides
* an extended set of assertions for comparisons: g_assert_cmpfloat(),
* g_assert_cmpfloat_with_epsilon(), g_assert_cmpint(), g_assert_cmpuint(),
@ -1684,6 +1688,8 @@ test_rm_isolate_dirs (void)
* test random number generator, the name for g_get_prgname()
* and parsing test related command line args.
*
* This should be called before calling any other `g_test_*()` functions.
*
* So far, the following arguments are understood:
*
* - `-l`: List test cases available in a test executable.