mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-23 09:19:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

[3.13] Update the availability info in the resource docs (GH-137939) (GH-139720)

Browse source 
(cherry picked from commit b4d8faa221)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
This commit is contained in:
Miss Islington (bot) 2025-10-07 22:33:20 +02:00 • committed by GitHub
parent 0404ca7201
commit 5074feb394
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

20
Doc/library/resource.rst
View file

@ -63,12 +63,12 @@ this module for those platforms.
Sets new limits of consumption of *resource*. The *limits* argument must be a
tuple ``(soft, hard)`` of two integers describing the new limits. A value of
:data:`~resource.RLIM_INFINITY` can be used to request a limit that is
:const:`~resource.RLIM_INFINITY` can be used to request a limit that is
unlimited.
Raises :exc:`ValueError` if an invalid resource is specified, if the new soft
limit exceeds the hard limit, or if a process tries to raise its hard limit.
Specifying a limit of :data:`~resource.RLIM_INFINITY` when the hard or
Specifying a limit of :const:`~resource.RLIM_INFINITY` when the hard or
system limit for that resource is not unlimited will result in a
:exc:`ValueError`. A process with the effective UID of super-user can
request any valid limit value, including unlimited, but :exc:`ValueError`
@ -78,7 +78,7 @@ this module for those platforms.
``setrlimit`` may also raise :exc:`error` if the underlying system call
fails.
VxWorks only supports setting :data:`RLIMIT_NOFILE`.
VxWorks only supports setting :const:`RLIMIT_NOFILE`.
.. audit-event:: resource.setrlimit resource,limits resource.setrlimit
@ -176,8 +176,9 @@ platform.
.. data:: RLIMIT_VMEM
The largest area of mapped memory which the process may occupy.
Usually an alias of :const:`RLIMIT_AS`.
.. availability:: FreeBSD >= 11.
.. availability:: Solaris, FreeBSD, NetBSD.
.. data:: RLIMIT_AS
@ -230,16 +231,18 @@ platform.
.. versionadded:: 3.4
.. data:: RLIMIT_SBSIZE
The maximum size (in bytes) of socket buffer usage for this user.
This limits the amount of network memory, and hence the amount of mbufs,
that this user may hold at any time.
.. availability:: FreeBSD.
.. availability:: FreeBSD, NetBSD.
.. versionadded:: 3.4
.. data:: RLIMIT_SWAP
The maximum size (in bytes) of the swap space that may be reserved or
@ -249,18 +252,20 @@ platform.
`tuning(7) <https://man.freebsd.org/cgi/man.cgi?query=tuning&sektion=7>`__
for a complete description of this sysctl.
.. availability:: FreeBSD.
.. availability:: FreeBSD >= 8.
.. versionadded:: 3.4
.. data:: RLIMIT_NPTS
The maximum number of pseudo-terminals created by this user id.
.. availability:: FreeBSD.
.. availability:: FreeBSD >= 8.
.. versionadded:: 3.4
.. data:: RLIMIT_KQUEUES
The maximum number of kqueues this user id is allowed to create.
@ -269,6 +274,7 @@ platform.
.. versionadded:: 3.10
Resource Usage
--------------