https://github.com/python/cpython/commit/9c18f75e7c7fd65d7c923a1693121334a5e3f93b
commit: 9c18f75e7c7fd65d7c923a1693121334a5e3f93b
branch: main
author: Weilin Du <[email protected]>
committer: hugovk <[email protected]>
date: 2025-10-20T10:15:40+03:00
summary:
gh-101100: Fix sphinx warnings in `library/resource.rst` (#140023)
files:
M Doc/library/resource.rst
M Doc/library/signal.rst
M Doc/tools/.nitignore
diff --git a/Doc/library/resource.rst b/Doc/library/resource.rst
index 9f6c3a88f0a0eb..c58dc4243ecb19 100644
--- a/Doc/library/resource.rst
+++ b/Doc/library/resource.rst
@@ -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.)
@@ -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.
diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst
index bbc4b91b921893..cdefcd29ef7fd5 100644
--- a/Doc/library/signal.rst
+++ b/Doc/library/signal.rst
@@ -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
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 29fd3cfda458f0..6fee1c192c3aff 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -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/socket.rst
Doc/library/ssl.rst
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: [email protected]
