From: Tor Lillqvist Date: Wed, 11 Jun 2008 06:57:22 +0000 (+0000) Subject: glib/gmain.c Clarify what a "child pid" is in the doc comments. X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=a689811a410623c69a257a857129f0d9e9d5d61f;p=dana%2Fcg-glib.git glib/gmain.c Clarify what a "child pid" is in the doc comments. 2008-06-11 Tor Lillqvist * glib/gmain.c * glib/gspawn.c: Clarify what a "child pid" is in the doc comments. svn path=/trunk/; revision=6995 --- diff --git a/ChangeLog b/ChangeLog index eb50688f..752ee8ed 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2008-06-11 Tor Lillqvist + + * glib/gmain.c + * glib/gspawn.c: Clarify what a "child pid" is in the doc + comments. + 2008-06-10 Matthias Clasen Bug 536158 – also bump GHashTable version when a node is removed via diff --git a/glib/gmain.c b/glib/gmain.c index e5ac91a3..b0c274c1 100644 --- a/glib/gmain.c +++ b/glib/gmain.c @@ -4003,8 +4003,8 @@ g_child_watch_source_init (void) /** * g_child_watch_source_new: - * @pid: process id of a child process to watch. On Windows, a HANDLE - * for the process to watch (which actually doesn't have to be a child). + * @pid: process to watch. On POSIX the pid of a child process. On + * Windows a handle for a process (which doesn't have to be a child). * * Creates a new child_watch source. * @@ -4054,7 +4054,8 @@ g_child_watch_source_new (GPid pid) * g_child_watch_add_full: * @priority: the priority of the idle source. Typically this will be in the * range between #G_PRIORITY_DEFAULT_IDLE and #G_PRIORITY_HIGH_IDLE. - * @pid: process id of a child process to watch + * @pid: process to watch. On POSIX the pid of a child process. On + * Windows a handle for a process (which doesn't have to be a child). * @function: function to call * @data: data to pass to @function * @notify: function to call when the idle is removed, or %NULL @@ -4103,7 +4104,8 @@ g_child_watch_add_full (gint priority, /** * g_child_watch_add: - * @pid: process id of a child process to watch + * @pid: process id to watch. On POSIX the pid of a child process. On + * Windows a handle for a process (which doesn't have to be a child). * @function: function to call * @data: data to pass to @function * diff --git a/glib/gspawn.c b/glib/gspawn.c index 16d26929..4c45eaf7 100644 --- a/glib/gspawn.c +++ b/glib/gspawn.c @@ -84,11 +84,14 @@ g_spawn_error_quark (void) * @flags: flags from #GSpawnFlags * @child_setup: function to run in the child just before exec() * @user_data: user data for @child_setup - * @child_pid: return location for child process ID, or %NULL + * @child_pid: return location for child process reference, or %NULL * @error: return location for error * * See g_spawn_async_with_pipes() for a full description; this function * simply calls the g_spawn_async_with_pipes() without any pipes. + * + * You should call g_spawn_close_pid() on the returned child process + * reference when you don't need it any more. * * * If you are writing a GTK+ application, and the program you @@ -97,6 +100,11 @@ g_spawn_error_quark (void) * the spawned program opens its windows on the right screen. * * + * Note that the returned @child_pid on Windows is a + * handle to the child process and not its identifier. Process handles + * and process identifiers are different concepts on Windows. + * + * * Return value: %TRUE on success, %FALSE if error is set **/ gboolean @@ -485,6 +493,10 @@ g_spawn_sync (const gchar *working_directory, * vector elements that need it before calling the C runtime * spawn() function. * + * The returned @child_pid on Windows is a handle to the child + * process, not its identifier. Process handles and process + * identifiers are different concepts on Windows. + * * @envp is a %NULL-terminated array of strings, where each string * has the form KEY=VALUE. This will become * the child's environment. If @envp is %NULL, the child inherits its @@ -577,7 +589,7 @@ g_spawn_sync (const gchar *working_directory, * and @standard_error will not be filled with valid values. * * If @child_pid is not %NULL and an error does not occur then the returned - * pid must be closed using g_spawn_close_pid(). + * process reference must be closed using g_spawn_close_pid(). * * * If you are writing a GTK+ application, and the program you @@ -1641,9 +1653,9 @@ g_execute (const gchar *file, /** * g_spawn_close_pid: - * @pid: The process identifier to close + * @pid: The process reference to close * - * On some platforms, notably WIN32, the #GPid type represents a resource + * On some platforms, notably Windows, the #GPid type represents a resource * which must be closed to prevent resource leaking. g_spawn_close_pid() * is provided for this purpose. It should be used on all platforms, even * though it doesn't do anything under UNIX.