]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] Update the availability info in the resource docs (GH-137939) (GH-139720)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 7 Oct 2025 20:33:20 +0000 (22:33 +0200)
committerGitHub <noreply@github.com>
Tue, 7 Oct 2025 20:33:20 +0000 (22:33 +0200)
(cherry picked from commit b4d8faa22142cde789388068d0230b9ffdd95eac)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Doc/library/resource.rst

index 0515d205bbca0bbf9e12ce0ebb9bfd331b0ce03f..140de234fb7dc8f68674be95b90e5292be586ec0 100644 (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
 --------------