Skip to content

Commit

Permalink
doc: mptcp: alphabetical order
Browse files Browse the repository at this point in the history
Similar to what is done in other 'sysctl' pages: it looks clearer from a
readability perspective.

This might cause troubles in the short/mid-term with the backports, but
by not putting new entries at the end, this can help to reduce conflicts
in case of backports in the long term. We don't change the information
here too often, so it looks OK to do that.

Reviewed-by: Mat Martineau <[email protected]>
Signed-off-by: Matthieu Baerts (NGI0) <[email protected]>
Signed-off-by: NipaLocal <nipa@local>
  • Loading branch information
matttbe authored and NipaLocal committed May 22, 2024
1 parent e5b7012 commit 569b9ba
Showing 1 changed file with 37 additions and 37 deletions.
74 changes: 37 additions & 37 deletions Documentation/networking/mptcp-sysctl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,6 @@ MPTCP Sysfs variables
/proc/sys/net/mptcp/* Variables
===============================

enabled - BOOLEAN
Control whether MPTCP sockets can be created.

MPTCP sockets can be created if the value is 1. This is a
per-namespace sysctl.

Default: 1 (enabled)

add_addr_timeout - INTEGER (seconds)
Set the timeout after which an ADD_ADDR control message will be
resent to an MPTCP peer that has not acknowledged a previous
Expand All @@ -25,16 +17,22 @@ add_addr_timeout - INTEGER (seconds)

Default: 120

close_timeout - INTEGER (seconds)
Set the make-after-break timeout: in absence of any close or
shutdown syscall, MPTCP sockets will maintain the status
unchanged for such time, after the last subflow removal, before
moving to TCP_CLOSE.
allow_join_initial_addr_port - BOOLEAN
Allow peers to send join requests to the IP address and port number used
by the initial subflow if the value is 1. This controls a flag that is
sent to the peer at connection time, and whether such join requests are
accepted or denied.

The default value matches TCP_TIMEWAIT_LEN. This is a per-namespace
sysctl.
Joins to addresses advertised with ADD_ADDR are not affected by this
value.

Default: 60
This is a per-namespace sysctl.

Default: 1

available_schedulers - STRING
Shows the available schedulers choices that are registered. More packet
schedulers may be available, but not loaded.

checksum_enabled - BOOLEAN
Control whether DSS checksum can be enabled.
Expand All @@ -44,18 +42,24 @@ checksum_enabled - BOOLEAN

Default: 0

allow_join_initial_addr_port - BOOLEAN
Allow peers to send join requests to the IP address and port number used
by the initial subflow if the value is 1. This controls a flag that is
sent to the peer at connection time, and whether such join requests are
accepted or denied.
close_timeout - INTEGER (seconds)
Set the make-after-break timeout: in absence of any close or
shutdown syscall, MPTCP sockets will maintain the status
unchanged for such time, after the last subflow removal, before
moving to TCP_CLOSE.

Joins to addresses advertised with ADD_ADDR are not affected by this
value.
The default value matches TCP_TIMEWAIT_LEN. This is a per-namespace
sysctl.

This is a per-namespace sysctl.
Default: 60

Default: 1
enabled - BOOLEAN
Control whether MPTCP sockets can be created.

MPTCP sockets can be created if the value is 1. This is a
per-namespace sysctl.

Default: 1 (enabled)

pm_type - INTEGER
Set the default path manager type to use for each new MPTCP
Expand All @@ -74,6 +78,14 @@ pm_type - INTEGER

Default: 0

scheduler - STRING
Select the scheduler of your choice.

Support for selection of different schedulers. This is a per-namespace
sysctl.

Default: "default"

stale_loss_cnt - INTEGER
The number of MPTCP-level retransmission intervals with no traffic and
pending outstanding data on a given subflow required to declare it stale.
Expand All @@ -85,15 +97,3 @@ stale_loss_cnt - INTEGER
This is a per-namespace sysctl.

Default: 4

scheduler - STRING
Select the scheduler of your choice.

Support for selection of different schedulers. This is a per-namespace
sysctl.

Default: "default"

available_schedulers - STRING
Shows the available schedulers choices that are registered. More packet
schedulers may be available, but not loaded.

0 comments on commit 569b9ba

Please sign in to comment.