doc: improve doc of g_subprocess_wait()

When using this API, I wasn't sure what the cancellable does. I think
it's generally desirable to kill the subprocess if the wait operation is
cancelled, since in this case the application is no longer interested by
the subprocess.

https://bugzilla.gnome.org/show_bug.cgi?id=732704
This commit is contained in:
Sébastien Wilmet 2014-07-03 15:45:11 +02:00
parent c3842d1969
commit b0c7221c55

View File

@ -941,6 +941,9 @@ g_subprocess_sync_complete (GAsyncResult **result)
* This function does not fail in the case of the subprocess having
* abnormal termination. See g_subprocess_wait_check() for that.
*
* Cancelling @cancellable doesn't kill the subprocess. Call
* g_subprocess_force_exit() if it is desirable.
*
* Returns: %TRUE on success, %FALSE if @cancellable was cancelled
*
* Since: 2.40