Skip to content

[3.14] Update the availability info in the resource docs #137939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 3.14
Choose a base branch
from
Open

[3.14] Update the availability info in the resource docs #137939

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 13 additions & 7 deletions Doc/library/resource.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -269,6 +274,7 @@ platform.

.. versionadded:: 3.10


Resource Usage
--------------

Expand Down
Loading