Documentation: add description for a couple of sctp sysctl options
Subsystems (4)
Xin Long
maintainercover 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.
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 1/3 Documentation: add description for net.sctp.reconf_enable
Describe 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 2/3 Documentation: add description for net.sctp.intl_enable
In reply to Xin LongDescribe it in networking/ip-sysctl.rst like other SCTP options. We need to document this especailly 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 allow the interleaving of user + messages sent on different streams. With this feature enabled, I-DATA + chunk will replace DATA chunk to carry user messages. Note that to use + this feature, with this option set to 1, we also need socket options + SCTP_FRAGMENT_INTERLEAVE set to 2 and SCTP_INTERLEAVING_SUPPORTED set + to 1. + + - 1: Enable extension. + - 0: Disable extension. + + Default: 0 + ``/proc/sys/net/core/*`` ========================
Signature · 1 line
2.31.1
Marcelo Ricardo Leitner
maintainerRe: [PATCH net 2/3] Documentation: add description for net.sctp.intl_enable
Hi,
Quoted 2 lines · Xin Long
Describe it in
networking/ip-sysctl.rstlike other SCTP options. We need to document this especailly as when using the feature
especially
Quoted 14 lines
of User Message Interleaving, some socket options also needs to be set.
Fixes 463118c34a35 ("sctp: support sysctl to allow users to use stream interleave")Signed-off-by Xin Long <[email protected]>--- Documentation/networking/ip-sysctl.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+)Documentation/networking/ip-sysctl.rst +0
-0
Documentation/networking/ip-sysctl.rst reconf_enable - BOOLEAN · line 2946
Quoted 6 lines
Documentation/networking/ip-sysctl.rst +3
-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 allow the interleaving of user
allows
Documentation/networking/ip-sysctl.rst reconf_enable - BOOLEAN · line 2948
Quoted 2 lines
Documentation/networking/ip-sysctl.rst +2
-0+ messages sent on different streams. With this feature enabled, I-DATA + chunk will replace DATA chunk to carry user messages. Note that to use
.. to carry user messages if also supported by the peer.
Documentation/networking/ip-sysctl.rst reconf_enable - BOOLEAN · line 2951
Quoted 3 lines
Documentation/networking/ip-sysctl.rst +3
-0+ this feature, with this option set to 1, we also need socket options + SCTP_FRAGMENT_INTERLEAVE set to 2 and SCTP_INTERLEAVING_SUPPORTED set + to 1.
Perhaps for this last sentence:
Note that to use this feature, one needs to set this option to 1 and also need to set socket options SCTP_FRAGMENT_INTERLEAVE to 2 and SCTP_INTERLEAVING_SUPPORTED to 1.
My only comments on the set. Otherwise LGTM.
Quoted 12 lines
Documentation/networking/ip-sysctl.rst +6
-0+ + - 1: Enable extension. + - 0: Disable extension. + + Default: 0 + ``/proc/sys/net/core/*`` ========================Signature · 1 line
2.31.1
Xin Long
maintainerPATCH 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