git: d20f0dae2f97 - stable/14 - getrlimit(2): document RLIMIT_PIPEBUF

From: Konstantin Belousov <kib_at_FreeBSD.org>
Date: Sat, 05 Oct 2024 07:11:07 UTC
The branch stable/14 has been updated by kib:

URL: https://cgit.FreeBSD.org/src/commit/?id=d20f0dae2f97185cc53bda3fd3245453a77277f6

commit d20f0dae2f97185cc53bda3fd3245453a77277f6
Author:     Konstantin Belousov <kib@FreeBSD.org>
AuthorDate: 2024-09-10 04:11:55 +0000
Commit:     Konstantin Belousov <kib@FreeBSD.org>
CommitDate: 2024-10-05 07:08:54 +0000

    getrlimit(2): document RLIMIT_PIPEBUF
    
    (cherry picked from commit 54a8d1fbbf65e976132809718525ba051a5525cf)
---
 lib/libc/sys/getrlimit.2 | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/lib/libc/sys/getrlimit.2 b/lib/libc/sys/getrlimit.2
index 2e79b3000c69..dc8653076dba 100644
--- a/lib/libc/sys/getrlimit.2
+++ b/lib/libc/sys/getrlimit.2
@@ -86,6 +86,16 @@ The maximum number of open files for this process.
 The maximum number of simultaneous processes for this user id.
 .It Dv RLIMIT_NPTS
 The maximum number of pseudo-terminals this user id is allowed to create.
+.It Dv RLIMIT_PIPEBUF
+The maximum total size of in-kernel buffers for bi-directional pipes/fifos
+that this user id is allowed to consume.
+The buffers for kernel FIFOs created on the first open of a filesystem
+object created by
+.Pq Xr mkfifo 2
+are also charged to the user ID of the process opening it,
+not the FIFO's filesystem owner.
+Despite somewhat unexpected, this is in fact fair, since user of the fifo
+is not necessary its creator.
 .It Dv RLIMIT_RSS
 When there is memory pressure and swap is available, prioritize eviction of
 a process' resident pages beyond this amount (in bytes).