Move docs around

svn path=/trunk/; revision=7041

diff --git a/ChangeLog b/ChangeLog
index 9f16acf..6b4d50c 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2008-06-14  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/gtestutils.c: Move docs around
+
        * glib/gchecksum.h: Add docs.
 
 2008-06-13  Matthias Clasen  <mclasen@redhat.com>

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 5c4c8ba..64ed900 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,6 +1,9 @@
 2008-06-14  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/tmpl/testing.sgml: Move docs around
+
        * glib/tmpl/unicode.sgml: Document break types
+
        * glib/tmpl/hash_tables.sgml: Add docs for GHashTableIter
 
 2008-06-12  Matthias Clasen  <mclasen@redhat.com>

diff --git a/docs/reference/glib/tmpl/testing.sgml b/docs/reference/glib/tmpl/testing.sgml
index 52a218a..bb442b5 100644 (file)
--- a/docs/reference/glib/tmpl/testing.sgml
+++ b/docs/reference/glib/tmpl/testing.sgml
@@ -253,12 +253,24 @@ Returns %TRUE if tests are run in quite mode.
 
 <!-- ##### ENUM GTestTrapFlags ##### -->
 <para>
+Test traps are guards around forked tests. These flags
+determine what traps to set.
+</para>
+
+@G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout of the test child to 
+    <filename>/dev/null</filename> so it cannot be observed on the 
+    console during test runs. The actual output is still captured 
+    though to allow later tests with g_test_trap_assert_stdout().
+ 
+@G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to 
+    <filename>/dev/null</filename> so it cannot be observed on the 
+    console during test runs. The actual output is still captured 
+    though to allow later tests with g_test_trap_assert_stderr().
+ 
+@G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the forked 
+    child process is shared with stdin of its parent process. It is 
+    redirected to <filename>/dev/null</filename> otherwise.
 
-</para>
-
-@G_TEST_TRAP_SILENCE_STDOUT: 
-@G_TEST_TRAP_SILENCE_STDERR: 
-@G_TEST_TRAP_INHERIT_STDIN: 
 
 <!-- ##### FUNCTION g_test_trap_fork ##### -->
 <para>

diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index cd7a2cd..b042714 100644 (file)
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -1489,35 +1489,7 @@ test_time_stamp (void)
  * not return or that might abort. The forked test case is aborted
  * and considered failing if its run time exceeds @usec_timeout.
  *
- * The forking behavior can be configured with the following flags:
- * <variablelist>
- *   <varlistentry>
- *     <term>%G_TEST_TRAP_SILENCE_STDOUT</term>
- *     <listitem><para>
- *       redirect stdout of the test child to <filename>/dev/null</filename> 
- *       so it cannot be observed on the console during test runs. 
- *       The actual output is still captured though to allow later
- *       tests with g_test_trap_assert_stdout().
- *     </para></listitem>
- *   </varlistentry>
- *   <varlistentry>
- *     <term>%G_TEST_TRAP_SILENCE_STDERR</term>
- *     <listitem><para>
- *       redirect stderr of the test child to <filename>/dev/null</filename>
- *       so it cannot be observed on the console during test runs. 
- *       The actual output is still captured though to allow later
- *       tests with g_test_trap_assert_stderr().
- *     </para></listitem>
- *   </varlistentry>
- *   <varlistentry>
- *     <term>%G_TEST_TRAP_INHERIT_STDIN</term>
- *     <listitem><para>
- *       if this flag is given, stdin of the forked child process is 
- *       shared with stdin of its parent process. It is redirected to 
- *       <filename>/dev/null</filename> otherwise.
- *     </para></listitem>
- *   </varlistentry>
- * </variablelist>
+ * The forking behavior can be configured with the #GTestTrapFlags flags.
  *
  * In the following example, the test code forks, the forked child
  * process produces some sample output and exits successfully.