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

Merge #17409: Document RLIM_INFINITY and use it to clarify the setrlimit docs.

Browse source
This commit is contained in:
R David Murray 2013-04-20 13:40:33 -04:00
commit a6d67e6c5d
1 changed files with 17 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

21
Doc/library/resource.rst
View file

@ -43,6 +43,11 @@ which cannot be checked or controlled by the operating system are not defined in
this module for those platforms. this module for those platforms.
.. data:: RLIM_INFINITY
Constant used to represent the the limit for an unlimited resource.
.. function:: getrlimit(resource) .. function:: getrlimit(resource)
Returns a tuple ``(soft, hard)`` with the current soft and hard limits of Returns a tuple ``(soft, hard)`` with the current soft and hard limits of
@ -54,12 +59,20 @@ this module for those platforms.
Sets new limits of consumption of *resource*. The *limits* argument must be a 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 tuple ``(soft, hard)`` of two integers describing the new limits. A value of
``-1`` can be used to specify the maximum possible upper limit. :data:`~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 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 limit exceeds the hard limit, or if a process tries to raise its hard limit.
(unless the process has an effective UID of super-user). Can also raise Specifying a limit of :data:`~resource.RLIM_INFINITY` when the hard or
:exc:`error` if the underlying system call fails. 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`
will still be raised if the requested limit exceeds the system imposed
limit.
``setrlimit`` may also raise :exc:`error` if the underlying system call
fails.
These symbols define resources whose consumption can be controlled using the These symbols define resources whose consumption can be controlled using the
:func:`setrlimit` and :func:`getrlimit` functions described below. The values of :func:`setrlimit` and :func:`getrlimit` functions described below. The values of