mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-02-03 09:46:17 +01:00
testutils: Convert docs to markdown
Convert lists to markdown.
This commit is contained in:
parent
77a6014753
commit
4308d2be9a
@ -67,27 +67,19 @@
|
|||||||
* to established concepts found in the other test frameworks (JUnit, NUnit,
|
* to established concepts found in the other test frameworks (JUnit, NUnit,
|
||||||
* RUnit), which in turn is based on smalltalk unit testing concepts.
|
* RUnit), which in turn is based on smalltalk unit testing concepts.
|
||||||
*
|
*
|
||||||
* <variablelist>
|
* - Test case: Tests (test methods) are grouped together with their
|
||||||
* <varlistentry>
|
* fixture into test cases.
|
||||||
* <term>Test case</term>
|
*
|
||||||
* <listitem>Tests (test methods) are grouped together with their
|
* - Fixture: A test fixture consists of fixture data and setup and
|
||||||
* fixture into test cases.</listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* <varlistentry>
|
|
||||||
* <term>Fixture</term>
|
|
||||||
* <listitem>A test fixture consists of fixture data and setup and
|
|
||||||
* teardown methods to establish the environment for the test
|
* teardown methods to establish the environment for the test
|
||||||
* functions. We use fresh fixtures, i.e. fixtures are newly set
|
* functions. We use fresh fixtures, i.e. fixtures are newly set
|
||||||
* up and torn down around each test invocation to avoid dependencies
|
* up and torn down around each test invocation to avoid dependencies
|
||||||
* between tests.</listitem>
|
* between tests.
|
||||||
* </varlistentry>
|
*
|
||||||
* <varlistentry>
|
* - Test suite: Test cases can be grouped into test suites, to allow
|
||||||
* <term>Test suite</term>
|
|
||||||
* <listitem>Test cases can be grouped into test suites, to allow
|
|
||||||
* subsets of the available tests to be run. Test suites can be
|
* subsets of the available tests to be run. Test suites can be
|
||||||
* grouped into other test suites as well.</listitem>
|
* grouped into other test suites as well.
|
||||||
* </varlistentry>
|
*
|
||||||
* </variablelist>
|
|
||||||
* The API is designed to handle creation and registration of test suites
|
* The API is designed to handle creation and registration of test suites
|
||||||
* and test cases implicitly. A simple call like
|
* and test cases implicitly. A simple call like
|
||||||
* |[
|
* |[
|
||||||
@ -1024,82 +1016,32 @@ parse_args (gint *argc_p,
|
|||||||
* Initialize the GLib testing framework, e.g. by seeding the
|
* Initialize the GLib testing framework, e.g. by seeding the
|
||||||
* test random number generator, the name for g_get_prgname()
|
* test random number generator, the name for g_get_prgname()
|
||||||
* and parsing test related command line args.
|
* and parsing test related command line args.
|
||||||
|
*
|
||||||
* So far, the following arguments are understood:
|
* So far, the following arguments are understood:
|
||||||
* <variablelist>
|
*
|
||||||
* <varlistentry>
|
* - <option>-l</option>: List test cases available in a test executable.
|
||||||
* <term><option>-l</option></term>
|
* - <option>--seed=SEED</option>: Provide a random seed to reproduce test
|
||||||
* <listitem><para>
|
* runs using random numbers.
|
||||||
* List test cases available in a test executable.
|
* - <option>--verbose</option>: Run tests verbosely.
|
||||||
* </para></listitem>
|
* - <option>-q</option>, <option>--quiet</option>: Run tests quietly.
|
||||||
* </varlistentry>
|
* - <option>-p PATH</option>: Execute all tests matching the given path.
|
||||||
* <varlistentry>
|
|
||||||
* <term><option>--seed=<replaceable>RANDOMSEED</replaceable></option></term>
|
|
||||||
* <listitem><para>
|
|
||||||
* Provide a random seed to reproduce test runs using random numbers.
|
|
||||||
* </para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* <varlistentry>
|
|
||||||
* <term><option>--verbose</option></term>
|
|
||||||
* <listitem><para>Run tests verbosely.</para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* <varlistentry>
|
|
||||||
* <term><option>-q</option>, <option>--quiet</option></term>
|
|
||||||
* <listitem><para>Run tests quietly.</para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* <varlistentry>
|
|
||||||
* <term><option>-p <replaceable>TESTPATH</replaceable></option></term>
|
|
||||||
* <listitem><para>
|
|
||||||
* Execute all tests matching <replaceable>TESTPATH</replaceable>.
|
|
||||||
* This can also be used to force a test to run that would otherwise
|
* This can also be used to force a test to run that would otherwise
|
||||||
* be skipped (ie, a test whose name contains "/subprocess").
|
* be skipped (ie, a test whose name contains "/subprocess").
|
||||||
* </para></listitem>
|
* - <option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option>: Execute tests according to these test modes:
|
||||||
* </varlistentry>
|
*
|
||||||
* <varlistentry>
|
* <option>perf</option>: Performance tests, may take long and report results.
|
||||||
* <term><option>-m {perf|slow|thorough|quick|undefined|no-undefined}</option></term>
|
*
|
||||||
* <listitem><para>
|
* <option>slow</option>, <option>thorough</option>: Slow and thorough tests, may take quite long and maximize coverage.
|
||||||
* Execute tests according to these test modes:
|
*
|
||||||
* <variablelist>
|
* <option>quick</option>: Quick tests, should run really quickly and give good coverage.
|
||||||
* <varlistentry>
|
*
|
||||||
* <term>perf</term>
|
* <option>undefined</option>: Tests for undefined behaviour, may provoke programming errors
|
||||||
* <listitem><para>
|
|
||||||
* Performance tests, may take long and report results.
|
|
||||||
* </para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* <varlistentry>
|
|
||||||
* <term>slow, thorough</term>
|
|
||||||
* <listitem><para>
|
|
||||||
* Slow and thorough tests, may take quite long and
|
|
||||||
* maximize coverage.
|
|
||||||
* </para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* <varlistentry>
|
|
||||||
* <term>quick</term>
|
|
||||||
* <listitem><para>
|
|
||||||
* Quick tests, should run really quickly and give good coverage.
|
|
||||||
* </para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* <varlistentry>
|
|
||||||
* <term>undefined</term>
|
|
||||||
* <listitem><para>
|
|
||||||
* Tests for undefined behaviour, may provoke programming errors
|
|
||||||
* under g_test_trap_subprocess() or g_test_expect_messages() to check
|
* under g_test_trap_subprocess() or g_test_expect_messages() to check
|
||||||
* that appropriate assertions or warnings are given
|
* that appropriate assertions or warnings are given
|
||||||
* </para></listitem>
|
*
|
||||||
* </varlistentry>
|
* <option>no-undefined</option>: Avoid tests for undefined behaviour
|
||||||
* <varlistentry>
|
*
|
||||||
* <term>no-undefined</term>
|
* - <option>--debug-log</option>: Debug test logging output.
|
||||||
* <listitem><para>
|
|
||||||
* Avoid tests for undefined behaviour
|
|
||||||
* </para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* </variablelist>
|
|
||||||
* </para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* <varlistentry>
|
|
||||||
* <term><option>--debug-log</option></term>
|
|
||||||
* <listitem><para>Debug test logging output.</para></listitem>
|
|
||||||
* </varlistentry>
|
|
||||||
* </variablelist>
|
|
||||||
*
|
*
|
||||||
* Since: 2.16
|
* Since: 2.16
|
||||||
*/
|
*/
|
||||||
|
Loading…
Reference in New Issue
Block a user