diff mbox series

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

Message ID eb4af790717c41995cd8bee67686d69e6fbb141d.1658414146.git.lucien.xin@gmail.com (mailing list archive)
State Accepted
Commit aa709da0e032cee7c202047ecd75f437bb0126ed
Delegated to: Netdev Maintainers
Headers show
Series [PATCHv2,net] Documentation: fix sctp_wmem in ip-sysctl.rst | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net
netdev/fixes_present success Fixes tag present in non-next series
netdev/subject_prefix success Link
netdev/cover_letter success Single patches do not need cover letters
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers fail 1 blamed authors not CCed: nhorman@tuxdriver.com; 5 maintainers not CCed: corbet@lwn.net nhorman@tuxdriver.com pabeni@redhat.com linux-doc@vger.kernel.org edumazet@google.com
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 15 lines checked
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Xin Long July 21, 2022, 2:35 p.m. UTC
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(-)

Comments

Marcelo Ricardo Leitner July 24, 2022, 1:06 p.m. UTC | #1
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>
patchwork-bot+netdevbpf@kernel.org July 24, 2022, 8:50 p.m. UTC | #2
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!
diff mbox series

Patch

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