| Message ID | 1fc59e854d7b9c66f4ab681dbe2a9eb91219f3a4.1654279751.git.lucien.xin@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | Documentation: add description for a couple of sctp sysctl options | expand |
Hi, On Fri, Jun 03, 2022 at 02:09:24PM -0400, Xin Long wrote: > Describe it in networking/ip-sysctl.rst like other SCTP options. > We need to document this especailly as when using the feature especially > 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 <lucien.xin@gmail.com> > --- > Documentation/networking/ip-sysctl.rst | 14 ++++++++++++++ > 1 file changed, 14 insertions(+) > > diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst > index 3abd494053a9..b67f2f83ff32 100644 > --- a/Documentation/networking/ip-sysctl.rst > +++ b/Documentation/networking/ip-sysctl.rst > @@ -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 > + 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. > + 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. > + > + - 1: Enable extension. > + - 0: Disable extension. > + > + Default: 0 > + > > ``/proc/sys/net/core/*`` > ======================== > -- > 2.31.1 >
diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst index 3abd494053a9..b67f2f83ff32 100644 --- a/Documentation/networking/ip-sysctl.rst +++ b/Documentation/networking/ip-sysctl.rst @@ -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/*`` ========================
Describe 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. Fixes: 463118c34a35 ("sctp: support sysctl to allow users to use stream interleave") Signed-off-by: Xin Long <lucien.xin@gmail.com> --- Documentation/networking/ip-sysctl.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+)