[PATCHv2 net] Documentation: fix sctp_wmem in ip-sysctl.rst

[PATCHv2 net] Documentation: fix sctp_wmem in ip-sysctl.rst

[Xin Long]

Since commit 1033990ac5b2 ("sctp: implement memory accounting on tx path"),
SCTP has supported memory accounting on tx path where 'sctp_wmem' is used
by sk_wmem_schedule(). So we should fix the description for this option in
ip-sysctl.rst accordingly.

v1->v2:
  - Improve the description as Marcelo suggested.

Fixes: 1033990ac5b2 ("sctp: implement memory accounting on tx path")
Signed-off-by: Xin Long <lucien.xin@gmail.com>
---
 Documentation/networking/ip-sysctl.rst | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
index 0e58001f8580..af2f0dfd50db 100644
--- a/Documentation/networking/ip-sysctl.rst
+++ b/Documentation/networking/ip-sysctl.rst
@@ -2870,7 +2870,14 @@ sctp_rmem - vector of 3 INTEGERs: min, default, max
 	Default: 4K
 
 sctp_wmem  - vector of 3 INTEGERs: min, default, max
-	Currently this tunable has no effect.
+	Only the first value ("min") is used, "default" and "max" are
+	ignored.
+
+	min: Minimum size of send buffer that can be used by SCTP sockets.
+	It is guaranteed to each SCTP socket (but not association) even
+	under moderate memory pressure.
+
+	Default: 4K
 
 addr_scope_policy - INTEGER
 	Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00
-- 
2.31.1

Re: [PATCHv2 net] Documentation: fix sctp_wmem in ip-sysctl.rst

[Marcelo Ricardo Leitner]

On Thu, Jul 21, 2022 at 10:35:46AM -0400, Xin Long wrote:
> Since commit 1033990ac5b2 ("sctp: implement memory accounting on tx path"),
> SCTP has supported memory accounting on tx path where 'sctp_wmem' is used
> by sk_wmem_schedule(). So we should fix the description for this option in
> ip-sysctl.rst accordingly.
> 
> v1->v2:
>   - Improve the description as Marcelo suggested.
> 
> Fixes: 1033990ac5b2 ("sctp: implement memory accounting on tx path")
> Signed-off-by: Xin Long <lucien.xin@gmail.com>

Acked-by: Marcelo Ricardo Leitner <marcelo.leitner@gmail.com>

Re: [PATCHv2 net] Documentation: fix sctp_wmem in ip-sysctl.rst

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net.git (master)
by David S. Miller <davem@davemloft.net>:

On Thu, 21 Jul 2022 10:35:46 -0400 you wrote:
> Since commit 1033990ac5b2 ("sctp: implement memory accounting on tx path"),
> SCTP has supported memory accounting on tx path where 'sctp_wmem' is used
> by sk_wmem_schedule(). So we should fix the description for this option in
> ip-sysctl.rst accordingly.
> 
> v1->v2:
>   - Improve the description as Marcelo suggested.
> 
> [...]

Here is the summary with links:
  - [PATCHv2,net] Documentation: fix sctp_wmem in ip-sysctl.rst
    https://git.kernel.org/netdev/net/c/aa709da0e032

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html