diff mbox series

[mptcp-next,2/3] doc: mptcp: alphabetical order

Message ID 20240517-mptcp-doc-v1-2-fc1ef063584e@kernel.org (mailing list archive)
State Superseded, archived
Commit b720ebf6d5551a0632d1fe6b5ae6627116415f3f
Delegated to: Matthieu Baerts
Headers show
Series doc: introduce MPTCP global doc | expand

Checks

Context Check Description
matttbe/build success Build and static analysis OK
matttbe/checkpatch success total: 0 errors, 0 warnings, 0 checks, 94 lines checked
matttbe/shellcheck success MPTCP selftests files have not been modified
matttbe/KVM_Validation__normal success Success! ✅
matttbe/KVM_Validation__debug success Success! ✅
matttbe/KVM_Validation__btf__only_bpftest_all_ success Success! ✅

Commit Message

Matthieu Baerts (NGI0) May 17, 2024, 5:40 p.m. UTC
Similar to what is done in other 'sysctl' pages.

Also, by not putting new entries at the end, this can help to reduce
conflicts in case of backports.

Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
---
 Documentation/networking/mptcp-sysctl.rst | 78 +++++++++++++++----------------
 1 file changed, 39 insertions(+), 39 deletions(-)

Comments

Mat Martineau May 17, 2024, 8:37 p.m. UTC | #1
On Fri, 17 May 2024, Matthieu Baerts (NGI0) wrote:

> Similar to what is done in other 'sysctl' pages.
>
> Also, by not putting new entries at the end, this can help to reduce
> conflicts in case of backports.
>

Putting these in order makes sense to me from a readability perspective. 
This does replace one backporting problem with another, but we don't 
change the information here too often.

Reviewed-by: Mat Martineau <martineau@kernel.org>


> Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
> ---
> Documentation/networking/mptcp-sysctl.rst | 78 +++++++++++++++----------------
> 1 file changed, 39 insertions(+), 39 deletions(-)
>
> diff --git a/Documentation/networking/mptcp-sysctl.rst b/Documentation/networking/mptcp-sysctl.rst
> index 102a45e7bfa8..fd514bba8c43 100644
> --- a/Documentation/networking/mptcp-sysctl.rst
> +++ b/Documentation/networking/mptcp-sysctl.rst
> @@ -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,25 +17,6 @@ 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.
> -
> -	The default value matches TCP_TIMEWAIT_LEN. This is a per-namespace
> -	sysctl.
> -
> -	Default: 60
> -
> -checksum_enabled - BOOLEAN
> -	Control whether DSS checksum can be enabled.
> -
> -	DSS checksum can be enabled if the value is nonzero. This is a
> -	per-namespace sysctl.
> -
> -	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
> @@ -57,6 +30,37 @@ allow_join_initial_addr_port - BOOLEAN
>
> 	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.
> +
> +	DSS checksum can be enabled if the value is nonzero. This is a
> +	per-namespace sysctl.
> +
> +	Default: 0
> +
> +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.
> +
> +	The default value matches TCP_TIMEWAIT_LEN. This is a per-namespace
> +	sysctl.
> +
> +	Default: 60
> +
> +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
> 	socket. In-kernel path management will control subflow
> @@ -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.
>
> -- 
> 2.43.0
>
>
>
Matthieu Baerts (NGI0) May 18, 2024, 3:46 p.m. UTC | #2
On 17/05/2024 22:37, Mat Martineau wrote:
> On Fri, 17 May 2024, Matthieu Baerts (NGI0) wrote:
> 
>> Similar to what is done in other 'sysctl' pages.
>>
>> Also, by not putting new entries at the end, this can help to reduce
>> conflicts in case of backports.
>>
> 
> Putting these in order makes sense to me from a readability perspective.
> This does replace one backporting problem with another, but we don't
> change the information here too often.

Thank you, good point, I will update the commit message in the v2 to
make this clearer :)

Cheers,
Matt
diff mbox series

Patch

diff --git a/Documentation/networking/mptcp-sysctl.rst b/Documentation/networking/mptcp-sysctl.rst
index 102a45e7bfa8..fd514bba8c43 100644
--- a/Documentation/networking/mptcp-sysctl.rst
+++ b/Documentation/networking/mptcp-sysctl.rst
@@ -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,25 +17,6 @@  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.
-
-	The default value matches TCP_TIMEWAIT_LEN. This is a per-namespace
-	sysctl.
-
-	Default: 60
-
-checksum_enabled - BOOLEAN
-	Control whether DSS checksum can be enabled.
-
-	DSS checksum can be enabled if the value is nonzero. This is a
-	per-namespace sysctl.
-
-	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
@@ -57,6 +30,37 @@  allow_join_initial_addr_port - BOOLEAN
 
 	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.
+
+	DSS checksum can be enabled if the value is nonzero. This is a
+	per-namespace sysctl.
+
+	Default: 0
+
+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.
+
+	The default value matches TCP_TIMEWAIT_LEN. This is a per-namespace
+	sysctl.
+
+	Default: 60
+
+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
 	socket. In-kernel path management will control subflow
@@ -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.