diff mbox series

[v2] manual: make setrlimit() description less ambiguous

Message ID 20240729090817.15383-1-lukas.bulwahn@redhat.com
State New
Headers show
Series [v2] manual: make setrlimit() description less ambiguous | expand

Commit Message

Lukas Bulwahn July 29, 2024, 9:08 a.m. UTC
From: Lukas Bulwahn <lukas.bulwahn@redhat.com>

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.
---

v1 -> v2: dropped the signed-off-by, as already covered by Red Hat's
copyright assignment.

 manual/resource.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Florian Weimer July 29, 2024, 9:22 a.m. UTC | #1
* Lukas Bulwahn:

> From: Lukas Bulwahn <lukas.bulwahn@redhat.com>
>
> 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.
> ---
>
> v1 -> v2: dropped the signed-off-by, as already covered by Red Hat's
> copyright assignment.
>
>  manual/resource.texi | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/manual/resource.texi b/manual/resource.texi
> index c9b21dedeb..25966bcb64 100644
> --- a/manual/resource.texi
> +++ b/manual/resource.texi
> @@ -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:

Thanks, it's an improvement, so I'll apply this.

Reviewed-by: Florian Weimer <fweimer@redhat.com>

Florian
diff mbox series

Patch

diff --git a/manual/resource.texi b/manual/resource.texi
index c9b21dedeb..25966bcb64 100644
--- a/manual/resource.texi
+++ b/manual/resource.texi
@@ -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: