hook up testutils docs

svn path=/trunk/; revision=6296

ChangeLog

@@ -1,3 +1,7 @@
+2008-01-11  Matthias Clasen  <mclasen@redhat.com>
+
+	* glib/gtestutils.c: Fix a docs typo
+
 2008-01-11 12:55:19  Tim Janik  <timj@imendio.com>
 
 	* tests/testingbase64.c: added g_base64_encode()/g_base64_decode()

docs/reference/ChangeLog

@@ -1,3 +1,7 @@
+2008-01-11  Matthias Clasen  <mclasen@redhat.com>
+	
+	* glib/*: Hook up gtestutils docs.
+	
 2008-01-08  Alexander Larsson  <alexl@redhat.com>
 
         * gio/gio-docs.xml:

docs/reference/glib/glib-docs.sgml

@@ -65,6 +65,7 @@
 <!ENTITY glib-Regex SYSTEM "xml/gregex.xml">
 <!ENTITY glib-Version SYSTEM "xml/version.xml">
 <!ENTITY glib-Uri SYSTEM "xml/gurifuncs.xml">
+<!ENTITY glib-Testing SYSTEM "xml/testing.xml">
 
 <!ENTITY glib-Compiling SYSTEM "compiling.sgml">
 <!ENTITY glib-Building SYSTEM "building.sgml">
@@ -162,6 +163,7 @@ synchronize their operation.
     &glib-Markup;
     &glib-Keyfile;
     &glib-Bookmarkfile;
+    &glib-Testing;
     &glib-Windows-Compatibility-Functions;
   </chapter>
 

docs/reference/glib/glib-sections.txt

@@ -849,10 +849,9 @@ g_return_if_fail
 g_return_val_if_fail
 g_return_if_reached
 g_return_val_if_reached
-
+g_warn_if_fail
-<SUBSECTION>
+g_warn_if_reached
-g_assert
+g_warn_message
-g_assert_not_reached
 
 <SUBSECTION>
 g_on_error_query
@@ -2542,3 +2541,89 @@ g_checksum_get_digest
 g_compute_checksum_for_data
 g_compute_checksum_for_string
 </SECTION>
+
+<SECTION>
+<TITLE>Testing</TITLE>
+<FILE>testing</FILE>
+GTestCase
+GTestSuite
+g_test_minimized_result
+g_test_maximized_result
+g_test_init
+g_test_quick
+g_test_slow
+g_test_thorough
+g_test_perf
+g_test_verbose
+g_test_quiet
+g_test_run
+g_test_add_func
+g_test_add_data_func
+g_test_add
+
+g_test_message
+g_test_bug_base
+g_test_bug
+
+g_test_timer_start
+g_test_timer_elapsed
+g_test_timer_last
+
+g_test_queue_free
+g_test_queue_destroy
+g_test_queue_unref
+
+GTestTrapFlags
+g_test_trap_fork
+g_test_trap_has_passed
+g_test_trap_reached_timeout
+g_test_trap_assert_passed
+g_test_trap_assert_failed
+g_test_trap_assert_stdout
+g_test_trap_assert_stdout_unmatched
+g_test_trap_assert_stderr
+g_test_trap_assert_stderr_unmatched
+
+g_test_rand_bit
+g_test_rand_int
+g_test_rand_int_range
+g_test_rand_double
+g_test_rand_double_range
+
+g_assert
+g_assert_not_reached
+g_assert_cmpstr
+g_assert_cmpint
+g_assert_cmpuint
+g_assert_cmphex
+g_assert_cmpfloat
+g_strcmp0
+
+<SUBSECTION Private>
+g_test_create_case
+g_test_create_suite
+g_test_get_root
+g_test_suite_add
+g_test_suite_add_suite
+g_test_run_suite
+
+g_test_trap_assertions
+g_assertion_message
+g_assertion_message_expr
+g_assertion_message_cmpstr
+g_assertion_message_cmpnum
+
+g_test_add_vtable
+GTestConfig
+g_test_config_vars
+GTestLogType
+GTestLogMsg
+GTestLogBuffer
+
+g_test_log_type_name
+g_test_log_buffer_new
+g_test_log_buffer_free
+g_test_log_buffer_push
+g_test_log_buffer_pop
+g_test_log_msg_free
+</SECTION>

docs/reference/glib/tmpl/glib-unused.sgml

@@ -48,6 +48,30 @@ Desktop Entry Parser
 
 
 
+<!-- ##### SECTION ./tmpl/testutils.sgml:Long_Description ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/testutils.sgml:See_Also ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### SECTION ./tmpl/testutils.sgml:Short_Description ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/testutils.sgml:Stability_Level ##### -->
+
+
+
+<!-- ##### SECTION ./tmpl/testutils.sgml:Title ##### -->
+Testing
+
+
 <!-- ##### ENUM GChannelError ##### -->
 <para>
 
@@ -653,6 +677,14 @@ in any UNIX manual.
 @error: 
 @Returns: 
 
+<!-- ##### FUNCTION g_format_file_size_for_display ##### -->
+<para>
+
+</para>
+
+@size: 
+@Returns: 
+
 <!-- ##### FUNCTION g_io_channel_error_quark ##### -->
 <para>
 

docs/reference/glib/tmpl/i18n.sgml

@@ -82,13 +82,10 @@ pass <option>--keyword=C_:1c,2</option> to xgettext when extracting
 messages. Note that this only works with GNU gettext >= 0.15. 
 </para></note>
 
-@Context: 
+@Context: a message context, must be a string literal
-@String: 
+@String: a message id, must be a string literal
 @Returns: the translated message
 @Since: 2.16
-<!-- # Unused Parameters # -->
-@msgctxt: a message context, must be a string literal
-@msgid: a message id, must be a string literal
 
 
 <!-- ##### MACRO N_ ##### -->

docs/reference/glib/tmpl/spawn.sgml

@@ -89,7 +89,11 @@ function will thus only affect the child, not the parent.
 <para>
 Note that POSIX allows only async-signal-safe functions (see signal(7)) 
 to be called in the child between fork() and exec(), which drastically 
-limits the usefulness of child setup functions. 
+limits the usefulness of child setup functions.  
+</para>
+
+<para>
+Also note that modifying the environment from 
 </para>
 
 <para>

docs/reference/glib/tmpl/threads.sgml

@@ -1728,43 +1728,43 @@ get_debug_flags ()
 <!-- ##### FUNCTION g_once_init_enter ##### -->
 <para>
 Function to be called when starting a critical initialization section.
-The argument value_location must point to a static 0-initialized variable
+The argument @value_location must point to a static 0-initialized variable
-that will be set to a value other than 0 at the end of the initialization section.
+that will be set to a value other than 0 at the end of the initialization 
-In combination with g_once_init_leave() and the unique address value_location,
+section.
+In combination with g_once_init_leave() and the unique address @value_location,
 it can be ensured that an initialization section will be executed only once
 during a program's life time, and that concurrent threads are blocked until
 initialization completed. To be used in constructs like this:
 </para>
 
 <para>
-<informalexample>
+<informalexample><programlisting>
-<programlisting>
 static gsize initialization_value = 0;
-if (g_once_init_enter (&amp;initialization_value))              // section start
+if (g_once_init_enter (&amp;initialization_value))              /* section start */
   {
-    gsize setup_value = 42; // initialization code here
+    gsize setup_value = 42; /* initialization code here */
-    g_once_init_leave (&amp;initialization_value, setup_value); // section end
+    g_once_init_leave (&amp;initialization_value, setup_value); /* section end */
   }
-// use initialization_value here
+/* use initialization_value here */
-</programlisting>
+</programlisting></informalexample>
-</informalexample>
 </para>
 
 @value_location: location of a static initializable variable containing 0.
-@Returns: %TRUE if the initialization section should be entered, %FALSE and blocks otheriwse
+@Returns: %TRUE if the initialization section should be entered, %FALSE and blocks otherwise
 @Since: 2.14
 
 
 <!-- ##### FUNCTION g_once_init_leave ##### -->
 <para>
-Counterpart to g_once_init_enter(). Expects a location of a static 0-initialized
+Counterpart to g_once_init_enter(). Expects a location of a static 
-initialization variable, and an initialization value other than 0. Sets the variable
+0-initialized initialization variable, and an initialization value other 
-to the initialization value, and releases concurrent threads blocking in
+than 0. Sets the variable to the initialization value, and releases 
-g_once_init_enter() on this initialization variable.
+concurrent threads blocking in g_once_init_enter() on this initialization 
+variable.
 </para>
 
 @value_location: location of a static initializable variable containing 0.
-@initialization_value: new non-0 value for *@value_location:
+@initialization_value: new non-0 value for *@value_location.
 @Since: 2.14
 
 

docs/reference/glib/tmpl/warnings.sgml

@@ -134,32 +134,33 @@ Logs a critical message and returns @val.
 @val: the value to return from the current function.
 
 
-<!-- ##### MACRO g_assert ##### -->
+<!-- ##### MACRO g_warn_if_fail ##### -->
 <para>
-Debugging macro to terminate the application if the assertion fails.
+
-If the assertion fails (i.e. the expression is not true), an error message
-is logged and the application is terminated.
-</para>
-<para>
-The macro can be turned off in final releases of code by defining
-#G_DISABLE_ASSERT when compiling the application.
 </para>
 
-@expr: the expression to check.
+@expr: 
 
 
-<!-- ##### MACRO g_assert_not_reached ##### -->
+<!-- ##### MACRO g_warn_if_reached ##### -->
 <para>
-Debugging macro to terminate the application if it is ever reached.
+
-If it is reached, an error message is logged and the application is terminated.
-</para>
-<para>
-The macro can be turned off in final releases of code by defining
-#G_DISABLE_ASSERT when compiling the application.
 </para>
 
 
 
+<!-- ##### FUNCTION g_warn_message ##### -->
+<para>
+
+</para>
+
+@domain: 
+@file: 
+@line: 
+@func: 
+@warnexpr: 
+
+
 <!-- ##### FUNCTION g_on_error_query ##### -->
 <para>
 Prompts the user with <computeroutput>[E]xit, [H]alt, show [S]tack trace or [P]roceed</computeroutput>.

glib/gtestutils.c

@@ -734,7 +734,8 @@ g_test_get_root (void)
  * Runs all tests under the toplevel suite which can be retrieved
  * with g_test_get_root(). Similar to g_test_run_suite(), the test
  * cases to be run are filtered according to
- * test path arguments (-p <testpath>) as parsed by g_test_init().
+ * test path arguments (-p <replaceable>testpath</replaceable>) as 
+ * parsed by g_test_init().
  * g_test_run_suite() or g_test_run() may only be called once
  * in a program.
  *