eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-15 01:08:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Document that you should read from processes before waiting for them to exit.

Browse source 
Fixes https://github.com/libsdl-org/SDL/issues/11645
This commit is contained in:
Sam Lantinga 2024-12-18 16:18:44 -08:00
parent 3001c61de0
commit f81472d767
1 changed files with 2 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/SDL3/SDL_process.h
View file

@ -371,6 +371,8 @@ extern SDL_DECLSPEC bool SDLCALL SDL_KillProcess(SDL_Process *process, bool forc
* normally, a negative signal if it terminated due to a signal, or -255
* otherwise. It will not be changed if the process is still running.
*
* If you create a process with standard output piped to the application (`pipe_stdio` being true) then you should read all of the process output before calling SDL_WaitProcess(). If you don't do this the process might be blocked indefinitely waiting for output to be read and SDL_WaitProcess() will never return true;
*
* \param process The process to wait for.
* \param block If true, block until the process finishes; otherwise, report
* on the process' status.