]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
doc: mptcp: alphabetical order
authorMatthieu Baerts (NGI0) <matttbe@kernel.org>
Thu, 30 May 2024 14:07:31 +0000 (16:07 +0200)
committerJakub Kicinski <kuba@kernel.org>
Sat, 1 Jun 2024 22:18:01 +0000 (15:18 -0700)
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 <martineau@kernel.org>
Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
Link: https://lore.kernel.org/r/20240530-upstream-net-20240520-mptcp-doc-v3-2-e94cdd9f2673@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Documentation/networking/mptcp-sysctl.rst

index 102a45e7bfa8a383eb718b7e6843fda3a65648f5..fd514bba8c431ca6489d76fc4d6b0a25ff52f490 100644 (file)
@@ -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
@@ -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.
@@ -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
@@ -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.
@@ -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.