Add Windows-specific note to the gtk-doc comment.

[platform/upstream/glib.git] / glib / gspawn.c

diff --git a/glib/gspawn.c b/glib/gspawn.c
index fd8ea60..33960e0 100644 (file)
--- a/glib/gspawn.c
+++ b/glib/gspawn.c
@@ -545,6 +545,14 @@ g_spawn_async_with_pipes (const gchar          *working_directory,
  * appropriate. Possible errors are those from g_spawn_sync() and those
  * from g_shell_parse_argv().
  * 
+ * On Windows, please note the implications of g_shell_parse_argv()
+ * parsing @command_line. Space is a separator, and backslashes are
+ * special. Thus you cannot simply pass a @command_line consisting of
+ * a canonical Windows path, like "c:\\program files\\app\\app.exe",
+ * as the backslashes will be eaten, and the space will act as a
+ * separator. You need to enclose the path with single quotes, like
+ * "'c:\\program files\\app\\app.exe'".
+ *
  * Return value: %TRUE on success, %FALSE if an error was set
  **/
 gboolean
@@ -592,6 +600,8 @@ g_spawn_command_line_sync (const gchar  *command_line,
  * consider using g_spawn_async() directly if appropriate. Possible
  * errors are those from g_shell_parse_argv() and g_spawn_async().
  * 
+ * The same concerns on Windows apply as for g_spawn_command_line_sync().
+ *
  * Return value: %TRUE on success, %FALSE if error is set.
  **/
 gboolean