Add Win32 warnings regarding the child setup function.

2005-03-29  Tor Lillqvist  <tml@novell.com>

	* glib/tmpl/spawn.sgml: Add Win32 warnings regarding the child
	setup function.

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 1fe143b..3529912 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2005-03-29  Tor Lillqvist  <tml@novell.com>
+
+       * glib/tmpl/spawn.sgml: Add Win32 warnings regarding the child
+       setup function.
+
 2005-03-21  Matthias Clasen  <mclasen@redhat.com>
 
        * glib/glib-sections.txt: 

diff --git a/docs/reference/glib/tmpl/spawn.sgml b/docs/reference/glib/tmpl/spawn.sgml
index aab7653..36615b4 100644 (file)
--- a/docs/reference/glib/tmpl/spawn.sgml
+++ b/docs/reference/glib/tmpl/spawn.sgml
@@ -77,10 +77,19 @@ Flags passed to g_spawn_sync(), g_spawn_async() and g_spawn_async_with_pipes().
 <!-- ##### USER_FUNCTION GSpawnChildSetupFunc ##### -->
 <para>
 Specifies the type of the setup function passed to g_spawn_async(),
-g_spawn_sync() and g_spawn_async_with_pipes(). It is called in the 
-child after GLib has performed all the setup it plans to perform 
-but before calling <function>exec()</function>. Obviously, actions 
-taken in this function will only affect the child, not the parent.
+g_spawn_sync() and g_spawn_async_with_pipes(). On POSIX platforms it
+is called in the child after GLib has performed all the setup it plans
+to perform but before calling <function>exec()</function>. On POSIX
+actions taken in this function will thus only affect the child, not
+the parent.
+</para>
+
+<para>
+On Windows the function is called in the parent. Its usefulness on
+Windows is thus questionable. In many cases executing the child setup
+function in the parent can have ill effects, and you should be very
+careful when porting software to Windows that uses child setup
+functions.
 </para>
 
 @user_data: user data to pass to the function.