Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2026-04-17 17:31:04 +00:00
Code Issues Projects Releases Packages Wiki Activity

[3.13] gh-101100: Fix sphinx warnings in library/resource.rst (GH-140023) (#140353)

Browse source 
Co-authored-by: Weilin Du <108666168+LamentXU123@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2025-10-20 09:23:27 +02:00 • committed by GitHub
parent 152e7d14dc
commit e5ebcabc6b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 43 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

74
Doc/library/resource.rst
View file

@ -127,7 +127,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.)
@ -310,47 +310,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.

6
Doc/library/signal.rst
View file

@ -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

1
Doc/tools/.nitignore
View file

@ -28,7 +28,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/socket.rst
Doc/library/ssl.rst