diff mbox series

[net] net/smc: fix documentation of buffer sizes

Message ID 20231030170343.748097-1-gbayer@linux.ibm.com (mailing list archive)
State Accepted
Commit a1602d749097386ec9e8e411a16a9c37ff6cd5fc
Delegated to: Netdev Maintainers
Headers show
Series [net] net/smc: fix documentation of buffer sizes | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net
netdev/fixes_present success Fixes tag present in non-next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 9 this patch: 9
netdev/cc_maintainers success CCed 11 of 11 maintainers
netdev/build_clang success Errors and warnings before: 9 this patch: 9
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
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: 9 this patch: 9
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 20 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Gerd Bayer Oct. 30, 2023, 5:03 p.m. UTC
Since commit 833bac7ec392 ("net/smc: Fix setsockopt and sysctl to
specify same buffer size again") the SMC protocol uses its own
default values for the smc.rmem and smc.wmem sysctl variables
which are no longer derived from the TCP IPv4 buffer sizes.

Fixup the kernel documentation to reflect this change, too.

Fixes: 833bac7ec392 ("net/smc: Fix setsockopt and sysctl to specify same buffer size again")
Signed-off-by: Gerd Bayer <gbayer@linux.ibm.com>
Reviewed-by: Wenjia Zhang <wenjia@linux.ibm.com>
---
 Documentation/networking/smc-sysctl.rst | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Dust Li Nov. 1, 2023, 1:07 a.m. UTC | #1
On Mon, Oct 30, 2023 at 06:03:43PM +0100, Gerd Bayer wrote:
>Since commit 833bac7ec392 ("net/smc: Fix setsockopt and sysctl to
>specify same buffer size again") the SMC protocol uses its own
>default values for the smc.rmem and smc.wmem sysctl variables
>which are no longer derived from the TCP IPv4 buffer sizes.
>
>Fixup the kernel documentation to reflect this change, too.
>
>Fixes: 833bac7ec392 ("net/smc: Fix setsockopt and sysctl to specify same buffer size again")
>Signed-off-by: Gerd Bayer <gbayer@linux.ibm.com>
>Reviewed-by: Wenjia Zhang <wenjia@linux.ibm.com>

Reviewed-by: Dust Li <dust.li@linux.alibaba.com>

>---
> Documentation/networking/smc-sysctl.rst | 6 ++----
> 1 file changed, 2 insertions(+), 4 deletions(-)
>
>diff --git a/Documentation/networking/smc-sysctl.rst b/Documentation/networking/smc-sysctl.rst
>index 6d8acdbe9be1..769149d98773 100644
>--- a/Documentation/networking/smc-sysctl.rst
>+++ b/Documentation/networking/smc-sysctl.rst
>@@ -44,18 +44,16 @@ smcr_testlink_time - INTEGER
> 
> wmem - INTEGER
> 	Initial size of send buffer used by SMC sockets.
>-	The default value inherits from net.ipv4.tcp_wmem[1].
> 
> 	The minimum value is 16KiB and there is no hard limit for max value, but
> 	only allowed 512KiB for SMC-R and 1MiB for SMC-D.
> 
>-	Default: 16K
>+	Default: 64KiB
> 
> rmem - INTEGER
> 	Initial size of receive buffer (RMB) used by SMC sockets.
>-	The default value inherits from net.ipv4.tcp_rmem[1].
> 
> 	The minimum value is 16KiB and there is no hard limit for max value, but
> 	only allowed 512KiB for SMC-R and 1MiB for SMC-D.
> 
>-	Default: 128K
>+	Default: 64KiB
>-- 
>2.41.0
patchwork-bot+netdevbpf@kernel.org Nov. 2, 2023, noon UTC | #2
Hello:

This patch was applied to netdev/net.git (main)
by Paolo Abeni <pabeni@redhat.com>:

On Mon, 30 Oct 2023 18:03:43 +0100 you wrote:
> Since commit 833bac7ec392 ("net/smc: Fix setsockopt and sysctl to
> specify same buffer size again") the SMC protocol uses its own
> default values for the smc.rmem and smc.wmem sysctl variables
> which are no longer derived from the TCP IPv4 buffer sizes.
> 
> Fixup the kernel documentation to reflect this change, too.
> 
> [...]

Here is the summary with links:
  - [net] net/smc: fix documentation of buffer sizes
    https://git.kernel.org/netdev/net/c/a1602d749097

You are awesome, thank you!
diff mbox series

Patch

diff --git a/Documentation/networking/smc-sysctl.rst b/Documentation/networking/smc-sysctl.rst
index 6d8acdbe9be1..769149d98773 100644
--- a/Documentation/networking/smc-sysctl.rst
+++ b/Documentation/networking/smc-sysctl.rst
@@ -44,18 +44,16 @@  smcr_testlink_time - INTEGER
 
 wmem - INTEGER
 	Initial size of send buffer used by SMC sockets.
-	The default value inherits from net.ipv4.tcp_wmem[1].
 
 	The minimum value is 16KiB and there is no hard limit for max value, but
 	only allowed 512KiB for SMC-R and 1MiB for SMC-D.
 
-	Default: 16K
+	Default: 64KiB
 
 rmem - INTEGER
 	Initial size of receive buffer (RMB) used by SMC sockets.
-	The default value inherits from net.ipv4.tcp_rmem[1].
 
 	The minimum value is 16KiB and there is no hard limit for max value, but
 	only allowed 512KiB for SMC-R and 1MiB for SMC-D.
 
-	Default: 128K
+	Default: 64KiB