Skip to content

Commit 5074feb

Browse files
[3.13] Update the availability info in the resource docs (GH-137939) (GH-139720)
(cherry picked from commit b4d8faa) Co-authored-by: Serhiy Storchaka <[email protected]>
1 parent 0404ca7 commit 5074feb

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

Doc/library/resource.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,12 @@ this module for those platforms.
6363

6464
Sets new limits of consumption of *resource*. The *limits* argument must be a
6565
tuple ``(soft, hard)`` of two integers describing the new limits. A value of
66-
:data:`~resource.RLIM_INFINITY` can be used to request a limit that is
66+
:const:`~resource.RLIM_INFINITY` can be used to request a limit that is
6767
unlimited.
6868

6969
Raises :exc:`ValueError` if an invalid resource is specified, if the new soft
7070
limit exceeds the hard limit, or if a process tries to raise its hard limit.
71-
Specifying a limit of :data:`~resource.RLIM_INFINITY` when the hard or
71+
Specifying a limit of :const:`~resource.RLIM_INFINITY` when the hard or
7272
system limit for that resource is not unlimited will result in a
7373
:exc:`ValueError`. A process with the effective UID of super-user can
7474
request any valid limit value, including unlimited, but :exc:`ValueError`
@@ -78,7 +78,7 @@ this module for those platforms.
7878
``setrlimit`` may also raise :exc:`error` if the underlying system call
7979
fails.
8080

81-
VxWorks only supports setting :data:`RLIMIT_NOFILE`.
81+
VxWorks only supports setting :const:`RLIMIT_NOFILE`.
8282

8383
.. audit-event:: resource.setrlimit resource,limits resource.setrlimit
8484

@@ -176,8 +176,9 @@ platform.
176176
.. data:: RLIMIT_VMEM
177177

178178
The largest area of mapped memory which the process may occupy.
179+
Usually an alias of :const:`RLIMIT_AS`.
179180

180-
.. availability:: FreeBSD >= 11.
181+
.. availability:: Solaris, FreeBSD, NetBSD.
181182

182183

183184
.. data:: RLIMIT_AS
@@ -230,16 +231,18 @@ platform.
230231

231232
.. versionadded:: 3.4
232233

234+
233235
.. data:: RLIMIT_SBSIZE
234236

235237
The maximum size (in bytes) of socket buffer usage for this user.
236238
This limits the amount of network memory, and hence the amount of mbufs,
237239
that this user may hold at any time.
238240

239-
.. availability:: FreeBSD.
241+
.. availability:: FreeBSD, NetBSD.
240242

241243
.. versionadded:: 3.4
242244

245+
243246
.. data:: RLIMIT_SWAP
244247

245248
The maximum size (in bytes) of the swap space that may be reserved or
@@ -249,18 +252,20 @@ platform.
249252
`tuning(7) <https://man.freebsd.org/cgi/man.cgi?query=tuning&sektion=7>`__
250253
for a complete description of this sysctl.
251254

252-
.. availability:: FreeBSD.
255+
.. availability:: FreeBSD >= 8.
253256

254257
.. versionadded:: 3.4
255258

259+
256260
.. data:: RLIMIT_NPTS
257261

258262
The maximum number of pseudo-terminals created by this user id.
259263

260-
.. availability:: FreeBSD.
264+
.. availability:: FreeBSD >= 8.
261265

262266
.. versionadded:: 3.4
263267

268+
264269
.. data:: RLIMIT_KQUEUES
265270

266271
The maximum number of kqueues this user id is allowed to create.
@@ -269,6 +274,7 @@ platform.
269274

270275
.. versionadded:: 3.10
271276

277+
272278
Resource Usage
273279
--------------
274280

0 commit comments

Comments
 (0)