[PATCH] docs: admin-guide: update to current minimum pipe size default

[PATCH] docs: admin-guide: update to current minimum pipe size default

[Štěpán Němec]

Fixes: 46c4c9d1beb7 ("pipe: increase minimum default pipe size to 2 pages")
Signed-off-by: Štěpán Němec <stepnem@smrk.net>
---
The relevant man page was updated in
7543e84442d7 ("pipe.7: Document change to default pipe size when soft limit is exceeded")
https://lore.kernel.org/linux-man/20240829204448.2027276-2-kstewart@efficios.com/
---
 Documentation/admin-guide/sysctl/fs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/admin-guide/sysctl/fs.rst b/Documentation/admin-guide/sysctl/fs.rst
index 6c54718c9d04ba0e690d064bc50f97ef883234fa..9b7f65c3efd8020d62df5b00388c48f2435da3e3 100644
--- a/Documentation/admin-guide/sysctl/fs.rst
+++ b/Documentation/admin-guide/sysctl/fs.rst
@@ -164,8 +164,8 @@ pipe-user-pages-soft
 --------------------
 
 Maximum total number of pages a non-privileged user may allocate for pipes
-before the pipe size gets limited to a single page. Once this limit is reached,
-new pipes will be limited to a single page in size for this user in order to
+before the pipe size gets limited to two pages. Once this limit is reached,
+new pipes will be limited to two pages in size for this user in order to
 limit total memory usage, and trying to increase them using ``fcntl()`` will be
 denied until usage goes below the limit again. The default value allows to
 allocate up to 1024 pipes at their default size. When set to 0, no limit is

---
base-commit: 038d61fd642278bab63ee8ef722c50d10ab01e8f
change-id: 20250728-pipedoc-ed3789cc42dc

Re: [PATCH] docs: admin-guide: update to current minimum pipe size default

[Jonathan Corbet]

Štěpán Němec <stepnem@smrk.net> writes:

> Fixes: 46c4c9d1beb7 ("pipe: increase minimum default pipe size to 2 pages")
> Signed-off-by: Štěpán Němec <stepnem@smrk.net>
> ---
> The relevant man page was updated in
> 7543e84442d7 ("pipe.7: Document change to default pipe size when soft limit is exceeded")
> https://lore.kernel.org/linux-man/20240829204448.2027276-2-kstewart@efficios.com/
> ---
>  Documentation/admin-guide/sysctl/fs.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/admin-guide/sysctl/fs.rst b/Documentation/admin-guide/sysctl/fs.rst
> index 6c54718c9d04ba0e690d064bc50f97ef883234fa..9b7f65c3efd8020d62df5b00388c48f2435da3e3 100644
> --- a/Documentation/admin-guide/sysctl/fs.rst
> +++ b/Documentation/admin-guide/sysctl/fs.rst
> @@ -164,8 +164,8 @@ pipe-user-pages-soft
>  --------------------
>  
>  Maximum total number of pages a non-privileged user may allocate for pipes
> -before the pipe size gets limited to a single page. Once this limit is reached,
> -new pipes will be limited to a single page in size for this user in order to
> +before the pipe size gets limited to two pages. Once this limit is reached,
> +new pipes will be limited to two pages in size for this user in order to
>  limit total memory usage, and trying to increase them using ``fcntl()`` will be

This seems like a reasonable change, but can I ask you to resubmit it
with a proper changelog, please?

Thanks,

jon

Re: [PATCH] docs: admin-guide: update to current minimum pipe size default

[Štěpán Němec]

On Mon, 28 Jul 2025 13:07:58 -0600
Jonathan Corbet wrote:

> Štěpán Němec <stepnem@smrk.net> writes:
>
>> Fixes: 46c4c9d1beb7 ("pipe: increase minimum default pipe size to 2 pages")
>> Signed-off-by: Štěpán Němec <stepnem@smrk.net>
>> ---

[...]

> This seems like a reasonable change, but can I ask you to resubmit it
> with a proper changelog, please?

Do you mean a better/longer commit message?

I felt that the Subject: and Fixes: says it all and didn't
want to duplicate information (contained in its commit
message and comments added by that change, as well as the
very paragraph we're updating here).

Would adding something like

  The pipe size limit used when the fs.pipe-user-pages-soft
  sysctl value is reached was increased from one to two
  pages in commit 46c4c9d1beb7; update the documentation to
  match the new reality.
  
work?

Thank you,

  Štěpán

Re: [PATCH] docs: admin-guide: update to current minimum pipe size default

[Jonathan Corbet]

Štěpán Němec <stepnem@smrk.net> writes:

> On Mon, 28 Jul 2025 13:07:58 -0600
> Jonathan Corbet wrote:
>
>> Štěpán Němec <stepnem@smrk.net> writes:
>>
>>> Fixes: 46c4c9d1beb7 ("pipe: increase minimum default pipe size to 2 pages")
>>> Signed-off-by: Štěpán Němec <stepnem@smrk.net>
>>> ---
>
> [...]
>
>> This seems like a reasonable change, but can I ask you to resubmit it
>> with a proper changelog, please?
>
> Do you mean a better/longer commit message?
>
> I felt that the Subject: and Fixes: says it all and didn't
> want to duplicate information (contained in its commit
> message and comments added by that change, as well as the
> very paragraph we're updating here).
>
> Would adding something like
>
>   The pipe size limit used when the fs.pipe-user-pages-soft
>   sysctl value is reached was increased from one to two
>   pages in commit 46c4c9d1beb7; update the documentation to
>   match the new reality.
>   
> work?

Yes, that is what I had in mind.  Patches should always explain
themselves without making people chase down Fixes tags and such.

Thanks,

jon