[3.8] bpo-40094: Enhance os.WIFEXITED documentation (GH-19244) by miss-islington · Pull Request #19277 · python/cpython
Expand Up
@@ -4128,45 +4128,55 @@ used to determine the disposition of a process.
Return ``True`` if a core dump was generated for the process, otherwise
return ``False``.
This function should be employed only if :func:`WIFSIGNALED` is true.
.. availability:: Unix.
.. function:: WIFCONTINUED(status)
Return ``True`` if the process has been continued from a job control stop, otherwise return ``False``. Return ``True`` if a stopped child has been resumed by delivery of :data:`~signal.SIGCONT` (if the process has been continued from a job control stop), otherwise return ``False``.
See :data:`WCONTINUED` option.
.. availability:: Unix.
.. function:: WIFSTOPPED(status)
Return ``True`` if the process has been stopped, otherwise return ``False``. Return ``True`` if the process was stopped by delivery of a signal, otherwise return ``False``.
.. availability:: Unix. :func:`WIFSTOPPED` only returns ``True`` if the :func:`waitpid` call was done using :data:`WUNTRACED` option or when the process is being traced (see :manpage:`ptrace(2)`).
.. availability:: Unix.
.. function:: WIFSIGNALED(status)
Return ``True`` if the process exited due to a signal, otherwise return Return ``True`` if the process was terminated by a signal, otherwise return ``False``.
.. availability:: Unix.
.. function:: WIFEXITED(status)
Return ``True`` if the process exited using the :manpage:`exit(2)` system call, Return ``True`` if the process exited terminated normally, that is, by calling ``exit()`` or ``_exit()``, or by returning from ``main()``; otherwise return ``False``.
.. availability:: Unix.
.. function:: WEXITSTATUS(status)
If ``WIFEXITED(status)`` is true, return the integer parameter to the :manpage:`exit(2)` system call. Otherwise, the return value is meaningless. Return the process exit status.
This function should be employed only if :func:`WIFEXITED` is true.
.. availability:: Unix.
Expand All @@ -4175,12 +4185,16 @@ used to determine the disposition of a process.
Return the signal which caused the process to stop.
This function should be employed only if :func:`WIFSTOPPED` is true.
.. availability:: Unix.
.. function:: WTERMSIG(status)
Return the signal which caused the process to exit. Return the number of the signal that caused the process to terminate.
This function should be employed only if :func:`WIFSIGNALED` is true.
.. availability:: Unix.
Expand Down
This function should be employed only if :func:`WIFSIGNALED` is true.
.. availability:: Unix.
.. function:: WIFCONTINUED(status)
Return ``True`` if the process has been continued from a job control stop, otherwise return ``False``. Return ``True`` if a stopped child has been resumed by delivery of :data:`~signal.SIGCONT` (if the process has been continued from a job control stop), otherwise return ``False``.
See :data:`WCONTINUED` option.
.. availability:: Unix.
.. function:: WIFSTOPPED(status)
Return ``True`` if the process has been stopped, otherwise return ``False``. Return ``True`` if the process was stopped by delivery of a signal, otherwise return ``False``.
.. availability:: Unix. :func:`WIFSTOPPED` only returns ``True`` if the :func:`waitpid` call was done using :data:`WUNTRACED` option or when the process is being traced (see :manpage:`ptrace(2)`).
.. availability:: Unix.
.. function:: WIFSIGNALED(status)
Return ``True`` if the process exited due to a signal, otherwise return Return ``True`` if the process was terminated by a signal, otherwise return ``False``.
.. availability:: Unix.
.. function:: WIFEXITED(status)
Return ``True`` if the process exited using the :manpage:`exit(2)` system call, Return ``True`` if the process exited terminated normally, that is, by calling ``exit()`` or ``_exit()``, or by returning from ``main()``; otherwise return ``False``.
.. availability:: Unix.
.. function:: WEXITSTATUS(status)
If ``WIFEXITED(status)`` is true, return the integer parameter to the :manpage:`exit(2)` system call. Otherwise, the return value is meaningless. Return the process exit status.
This function should be employed only if :func:`WIFEXITED` is true.
.. availability:: Unix.
Expand All @@ -4175,12 +4185,16 @@ used to determine the disposition of a process.
Return the signal which caused the process to stop.
This function should be employed only if :func:`WIFSTOPPED` is true.
.. availability:: Unix.
.. function:: WTERMSIG(status)
Return the signal which caused the process to exit. Return the number of the signal that caused the process to terminate.
This function should be employed only if :func:`WIFSIGNALED` is true.
.. availability:: Unix.
Expand Down