Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions Doc/library/resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ platform.
.. data:: RLIMIT_CPU

The maximum amount of processor time (in seconds) that a process can use. If
this limit is exceeded, a :const:`SIGXCPU` signal is sent to the process. (See
this limit is exceeded, a :const:`~signal.SIGXCPU` signal is sent to the process. (See
the :mod:`signal` module documentation for information about how to catch this
signal and do something useful, e.g. flush open files to disk.)

Expand Down Expand Up @@ -363,47 +363,47 @@ These functions are used to retrieve resource usage information:
For backward compatibility, the return value is also accessible as a tuple of 16
elements.

The fields :attr:`ru_utime` and :attr:`ru_stime` of the return value are
The fields :attr:`!ru_utime` and :attr:`!ru_stime` of the return value are
floating-point values representing the amount of time spent executing in user
mode and the amount of time spent executing in system mode, respectively. The
remaining values are integers. Consult the :manpage:`getrusage(2)` man page for
detailed information about these values. A brief summary is presented here:

+--------+---------------------+---------------------------------------+
| Index | Field | Resource |
+========+=====================+=======================================+
| ``0`` | :attr:`ru_utime` | time in user mode (float seconds) |
+--------+---------------------+---------------------------------------+
| ``1`` | :attr:`ru_stime` | time in system mode (float seconds) |
+--------+---------------------+---------------------------------------+
| ``2`` | :attr:`ru_maxrss` | maximum resident set size |
+--------+---------------------+---------------------------------------+
| ``3`` | :attr:`ru_ixrss` | shared memory size |
+--------+---------------------+---------------------------------------+
| ``4`` | :attr:`ru_idrss` | unshared memory size |
+--------+---------------------+---------------------------------------+
| ``5`` | :attr:`ru_isrss` | unshared stack size |
+--------+---------------------+---------------------------------------+
| ``6`` | :attr:`ru_minflt` | page faults not requiring I/O |
+--------+---------------------+---------------------------------------+
| ``7`` | :attr:`ru_majflt` | page faults requiring I/O |
+--------+---------------------+---------------------------------------+
| ``8`` | :attr:`ru_nswap` | number of swap outs |
+--------+---------------------+---------------------------------------+
| ``9`` | :attr:`ru_inblock` | block input operations |
+--------+---------------------+---------------------------------------+
| ``10`` | :attr:`ru_oublock` | block output operations |
+--------+---------------------+---------------------------------------+
| ``11`` | :attr:`ru_msgsnd` | messages sent |
+--------+---------------------+---------------------------------------+
| ``12`` | :attr:`ru_msgrcv` | messages received |
+--------+---------------------+---------------------------------------+
| ``13`` | :attr:`ru_nsignals` | signals received |
+--------+---------------------+---------------------------------------+
| ``14`` | :attr:`ru_nvcsw` | voluntary context switches |
+--------+---------------------+---------------------------------------+
| ``15`` | :attr:`ru_nivcsw` | involuntary context switches |
+--------+---------------------+---------------------------------------+
+--------+----------------------+---------------------------------------+
| Index | Field | Resource |
+========+======================+=======================================+
| ``0`` | :attr:`!ru_utime` | time in user mode (float seconds) |
+--------+----------------------+---------------------------------------+
| ``1`` | :attr:`!ru_stime` | time in system mode (float seconds) |
+--------+----------------------+---------------------------------------+
| ``2`` | :attr:`!ru_maxrss` | maximum resident set size |
+--------+----------------------+---------------------------------------+
| ``3`` | :attr:`!ru_ixrss` | shared memory size |
+--------+----------------------+---------------------------------------+
| ``4`` | :attr:`!ru_idrss` | unshared memory size |
+--------+----------------------+---------------------------------------+
| ``5`` | :attr:`!ru_isrss` | unshared stack size |
+--------+----------------------+---------------------------------------+
| ``6`` | :attr:`!ru_minflt` | page faults not requiring I/O |
+--------+----------------------+---------------------------------------+
| ``7`` | :attr:`!ru_majflt` | page faults requiring I/O |
+--------+----------------------+---------------------------------------+
| ``8`` | :attr:`!ru_nswap` | number of swap outs |
+--------+----------------------+---------------------------------------+
| ``9`` | :attr:`!ru_inblock` | block input operations |
+--------+----------------------+---------------------------------------+
| ``10`` | :attr:`!ru_oublock` | block output operations |
+--------+----------------------+---------------------------------------+
| ``11`` | :attr:`!ru_msgsnd` | messages sent |
+--------+----------------------+---------------------------------------+
| ``12`` | :attr:`!ru_msgrcv` | messages received |
+--------+----------------------+---------------------------------------+
| ``13`` | :attr:`!ru_nsignals` | signals received |
+--------+----------------------+---------------------------------------+
| ``14`` | :attr:`!ru_nvcsw` | voluntary context switches |
+--------+----------------------+---------------------------------------+
| ``15`` | :attr:`!ru_nivcsw` | involuntary context switches |
+--------+----------------------+---------------------------------------+

This function will raise a :exc:`ValueError` if an invalid *who* parameter is
specified. It may also raise :exc:`error` exception in unusual circumstances.
Expand Down
6 changes: 6 additions & 0 deletions Doc/library/signal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,12 @@ The variables defined in the :mod:`signal` module are:

.. availability:: Unix.

.. data:: SIGXCPU

CPU time limit exceeded.

.. availability:: Unix.

.. data:: SIG*

All the signal numbers are defined symbolically. For example, the hangup signal
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Doc/library/os.rst
Doc/library/pickletools.rst
Doc/library/profile.rst
Doc/library/pyexpat.rst
Doc/library/resource.rst
Doc/library/select.rst
Doc/library/smtplib.rst
Doc/library/socket.rst
Expand Down
Loading