Skip to content

Commit 814481e

Browse files
Update the availability info in the resource docs
1 parent 0324c72 commit 814481e

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
@@ -68,12 +68,12 @@ this module for those platforms.
6868

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

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

86-
VxWorks only supports setting :data:`RLIMIT_NOFILE`.
86+
VxWorks only supports setting :const:`RLIMIT_NOFILE`.
8787

8888
.. audit-event:: resource.setrlimit resource,limits resource.setrlimit
8989

@@ -181,8 +181,9 @@ platform.
181181
.. data:: RLIMIT_VMEM
182182

183183
The largest area of mapped memory which the process may occupy.
184+
Usually an alias of :const:`RLIMIT_AS`.
184185

185-
.. availability:: FreeBSD >= 11.
186+
.. availability:: Solaris, FreeBSD, NetBSD.
186187

187188

188189
.. data:: RLIMIT_AS
@@ -235,16 +236,18 @@ platform.
235236

236237
.. versionadded:: 3.4
237238

239+
238240
.. data:: RLIMIT_SBSIZE
239241

240242
The maximum size (in bytes) of socket buffer usage for this user.
241243
This limits the amount of network memory, and hence the amount of mbufs,
242244
that this user may hold at any time.
243245

244-
.. availability:: FreeBSD.
246+
.. availability:: FreeBSD, NetBSD.
245247

246248
.. versionadded:: 3.4
247249

250+
248251
.. data:: RLIMIT_SWAP
249252

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

257-
.. availability:: FreeBSD.
260+
.. availability:: FreeBSD >= 8.
258261

259262
.. versionadded:: 3.4
260263

264+
261265
.. data:: RLIMIT_NPTS
262266

263267
The maximum number of pseudo-terminals created by this user id.
264268

265-
.. availability:: FreeBSD.
269+
.. availability:: FreeBSD >= 8.
266270

267271
.. versionadded:: 3.4
268272

273+
269274
.. data:: RLIMIT_KQUEUES
270275

271276
The maximum number of kqueues this user id is allowed to create.
@@ -274,6 +279,7 @@ platform.
274279

275280
.. versionadded:: 3.10
276281

282+
277283
Resource Usage
278284
--------------
279285

0 commit comments

Comments
 (0)