Documentation: add description for a couple of sctp sysctl options
Subsystems (4)
Xin Long
maintainerv2 cover Documentation: add description for a couple of sctp sysctl options
These are a couple of sysctl options I recently added, but missed adding documents for them. Especially for net.sctp.intl_enable, it's hard for users to setup stream interleaving, as it also needs to call some socket options.
This patchset is to add documents for them.
v1->v2:
- Improved the description on Patch 2/3, as Marcelo suggested.
Xin Long (3):
Documentation: add description for net.sctp.reconf_enable
Documentation: add description for net.sctp.intl_enable
Documentation: add description for net.sctp.ecn_enable
Documentation/networking/ip-sysctl.rst | 37 ++++++++++++++++++++++++++ 1 file changed, 37 insertions(+)
Signature · 1 line
2.31.1
Xin Long
maintainerPATCH v2 2/3 Documentation: add description for net.sctp.intl_enable
Describe it in networking/ip-sysctl.rst like other SCTP options. We need to document this especially as when using the feature of User Message Interleaving, some socket options also needs to be set.
--- Documentation/networking/ip-sysctl.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
Documentation/networking/ip-sysctl.rst +14 -0
@@ -2941,6 +2941,20 @@ reconf_enable - BOOLEAN Default: 0 +intl_enable - BOOLEAN + Enable or disable extension of User Message Interleaving functionality + specified in RFC8260. This extension allows the interleaving of user + messages sent on different streams. With this feature enabled, I-DATA + chunk will replace DATA chunk to carry user messages if also supported + by the peer. Note that to use this feature, one needs to set this option + to 1 and also needs to set socket options SCTP_FRAGMENT_INTERLEAVE to 2 + and SCTP_INTERLEAVING_SUPPORTED to 1. + + - 1: Enable extension. + - 0: Disable extension. + + Default: 0 + ``/proc/sys/net/core/*`` ========================
Signature · 1 line
2.31.1
Xin Long
maintainerPATCH v2 1/3 Documentation: add description for net.sctp.reconf_enable
In reply to Xin LongDescribe it in networking/ip-sysctl.rst like other SCTP options.
--- Documentation/networking/ip-sysctl.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)
Documentation/networking/ip-sysctl.rst +11 -0
@@ -2930,6 +2930,17 @@ plpmtud_probe_interval - INTEGER Default: 0 +reconf_enable - BOOLEAN + Enable or disable extension of Stream Reconfiguration functionality + specified in RFC6525. This extension provides the ability to "reset" + a stream, and it includes the Parameters of "Outgoing/Incoming SSN + Reset", "SSN/TSN Reset" and "Add Outgoing/Incoming Streams". + + - 1: Enable extension. + - 0: Disable extension. + + Default: 0 + ``/proc/sys/net/core/*`` ========================
Signature · 1 line
2.31.1
Xin Long
maintainerPATCH v2 3/3 Documentation: add description for net.sctp.ecn_enable
In reply to Xin LongDescribe it in networking/ip-sysctl.rst like other SCTP options.
--- Documentation/networking/ip-sysctl.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+)
Documentation/networking/ip-sysctl.rst +12 -0
@@ -2955,6 +2955,18 @@ intl_enable - BOOLEAN Default: 0 +ecn_enable - BOOLEAN + Control use of Explicit Congestion Notification (ECN) by SCTP. + Like in TCP, ECN is used only when both ends of the SCTP connection + indicate support for it. This feature is useful in avoiding losses + due to congestion by allowing supporting routers to signal congestion + before having to drop packets. + + 1: Enable ecn. + 0: Disable ecn. + + Default: 1 + ``/proc/sys/net/core/*`` ========================
Signature · 1 line
2.31.1
Quoted 7 lines · Xin Long
These are a couple of sysctl options I recently added, but missed adding documents for them. Especially for net.sctp.intl_enable, it's hard for users to setup stream interleaving, as it also needs to call some socket options.
This patchset is to add documents for them.
Quoted 7 lines
v1->v2:
- Improved the description on Patch 2/3, as Marcelo suggested.Xin Long (3):
Documentation: add description for net.sctp.reconf_enable
Documentation: add description for net.sctp.intl_enable
Documentation: add description for net.sctp.ecn_enable
This series was applied to netdev/net.git (master) by Jakub Kicinski <[email protected]>:
Hello:
This series was applied to netdev/net.git (master) by Jakub Kicinski <[email protected]>:
Quoted 8 lines · On Thu, 9 Jun 2022 11:17:12 -0400 you wrote:
These are a couple of sysctl options I recently added, but missed adding documents for them. Especially for net.sctp.intl_enable, it's hard for users to setup stream interleaving, as it also needs to call some socket options.
This patchset is to add documents for them.
[...]
Here is the summary with links:
- [PATCHv2,net,1/3] Documentation: add description for net.sctp.reconf_enable
https://git.kernel.org/netdev/net/c/c349ae5f831c - [PATCHv2,net,2/3] Documentation: add description for net.sctp.intl_enable https://git.kernel.org/netdev/net/c/e65775fdd389 - [PATCHv2,net,3/3] Documentation: add description for net.sctp.ecn_enable https://git.kernel.org/netdev/net/c/249eddaf651f
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html