diff mbox series

manual: make setrlimit() description less ambiguous

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

Commit Message

Lukas Bulwahn July 29, 2024, 7:21 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.

Signed-off-by: Lukas Bulwahn <lukas.bulwahn@redhat.com>
---
 manual/resource.texi | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Florian Weimer July 29, 2024, 7:28 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.
>
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@redhat.com>
> ---
>  manual/resource.texi | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Sorry, is this patch covered by Red Hat's copyright assignment?  If it
is covered, please repost without the Signed-off-by.

Thanks,
Florian
Lukas Bulwahn July 29, 2024, 9:10 a.m. UTC | #2 
Hi Florian,

On Mon, Jul 29, 2024 at 9:28 AM Florian Weimer <fweimer@redhat.com> wrote:
>
> * 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.
> >
> > Signed-off-by: Lukas Bulwahn <lukas.bulwahn@redhat.com>
> > ---
> >  manual/resource.texi | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
>
> Sorry, is this patch covered by Red Hat's copyright assignment?  If it
> is covered, please repost without the Signed-off-by.
>

It is already covered, so I dropped the sign off and sent it again.

See v2:
https://inbox.sourceware.org/libc-alpha/20240729090817.15383-1-lukas.bulwahn@redhat.com/T/#u

Thanks for the review,

Lukas
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: