]> git.ipfire.org Git - thirdparty/glibc.git/commitdiff
manual: make setrlimit() description less ambiguous
authorLukas Bulwahn <lukas.bulwahn@redhat.com>
Mon, 29 Jul 2024 09:08:17 +0000 (11:08 +0200)
committerFlorian Weimer <fweimer@redhat.com>
Mon, 29 Jul 2024 14:03:45 +0000 (16:03 +0200)
The existing description for setrlimit() has some ambiguity. It could be
understood to have the semantics of getrlimit(), i.e., the limits from the
process are stored in the provided rlp pointer.

Make the description more explicit that rlp are the input values, and that
the limits of the process is changed with this function.

Reviewed-by: Florian Weimer <fweimer@redhat.com>
manual/resource.texi

index c9b21dedeb2f088851b05c8b79d3e33709ab31f5..25966bcb64fc13cb25284643468c226413a7ed3f 100644 (file)
@@ -192,8 +192,8 @@ If the sources are compiled with @code{_FILE_OFFSET_BITS == 64} on a
 @standards{BSD, sys/resource.h}
 @safety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 @c Direct syscall on most systems; lock-taking critical section on HURD.
-Store the current and maximum limits for the resource @var{resource}
-in @code{*@var{rlp}}.
+Change the current and maximum limits of the process for the resource
+@var{resource} to the values provided in @code{*@var{rlp}}.
 
 The return value is @code{0} on success and @code{-1} on failure.  The
 following @code{errno} error condition is possible: