[PATCH linux-next] Documentation: fix outdated interpretation of ip_no_pmtu_disc

From: xu xin <redacted>

The updating way of pmtu has changed, but documentation is still in the
old way. See commit-id 28d35bcdd3925e7293408cdb8aa5f2aac5f0d6e3. So This
patch fix interpretation of ip_no_pmtu_disc.

Besides, min_pmtu seems not to be discoverd, but set.

Reported-by: Zeal Robot <redacted>
Signed-off-by: xu xin <redacted>
---
 Documentation/networking/ip-sysctl.rst | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
index c04431144f7a..dd5e53318805 100644
--- a/Documentation/networking/ip-sysctl.rst
+++ b/Documentation/networking/ip-sysctl.rst

@@ -25,9 +25,11 @@ ip_default_ttl - INTEGER
 ip_no_pmtu_disc - INTEGER
 	Disable Path MTU Discovery. If enabled in mode 1 and a
 	fragmentation-required ICMP is received, the PMTU to this
-	destination will be set to min_pmtu (see below). You will need
-	to raise min_pmtu to the smallest interface MTU on your system
-	manually if you want to avoid locally generated fragments.
+	destination will be set to the smallest of the old MTU
+        and ip_rt_min_pmtu (see __ip_rt_update_pmtu() in
+        net/ipv4/route.c). You will need to raise min_pmtu to the
+        smallest interface MTU on your system manually if you want to
+        avoid locally generated fragments.
 
 	In mode 2 incoming Path MTU Discovery messages will be
 	discarded. Outgoing frames are handled the same as in mode 1,

@@ -49,7 +51,7 @@ ip_no_pmtu_disc - INTEGER
 	Default: FALSE
 
 min_pmtu - INTEGER
-	default 552 - minimum discovered Path MTU
+	default 552 - minimum set Path MTU
 
 ip_forward_use_pmtu - BOOLEAN
 	By default we don't trust protocol path MTUs while forwarding

-- 
2.25.1

On Wed, 29 Dec 2021 03:12:45 +0000 cgel.zte@gmail.com wrote:

From: xu xin <redacted>

The updating way of pmtu has changed, but documentation is still in the
old way. See commit-id 28d35bcdd3925e7293408cdb8aa5f2aac5f0d6e3. So This

not a correct way to quote a commit, please use: %h (\"%s\")
as the format.

patch fix interpretation of ip_no_pmtu_disc.

Besides, min_pmtu seems not to be discoverd, but set.

Reported-by: Zeal Robot <redacted>

How does the bot discover this sort of problem?

I don't see how this is a meaningful distinction to someone reading
this documentation, more of a corner case.

Use tabs instead of spaces.
 

Also not must of an improvement IMHO.

 ip_forward_use_pmtu - BOOLEAN
 	By default we don't trust protocol path MTUs while forwarding

From: xu xin <redacted>

The updating way of pmtu has changed, but documentation is still in the
old way. So this patch updates the interpretation of ip_no_pmtu_disc and
min_pmtu.

See commit 28d35bcdd3925 ("net: ipv4: don't let PMTU updates increase
route MTU")

Reported-by: Zeal Robot <redacted>
Signed-off-by: xu xin <redacted>
---
 Documentation/networking/ip-sysctl.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
index c04431144f7a..2572eecc3e86 100644
--- a/Documentation/networking/ip-sysctl.rst
+++ b/Documentation/networking/ip-sysctl.rst

@@ -25,7 +25,8 @@ ip_default_ttl - INTEGER
 ip_no_pmtu_disc - INTEGER
 	Disable Path MTU Discovery. If enabled in mode 1 and a
 	fragmentation-required ICMP is received, the PMTU to this
-	destination will be set to min_pmtu (see below). You will need
+	destination will be set to the smallest of the old MTU to
+	this destination and min_pmtu (see below). You will need
 	to raise min_pmtu to the smallest interface MTU on your system
 	manually if you want to avoid locally generated fragments.
 

@@ -49,7 +50,8 @@ ip_no_pmtu_disc - INTEGER
 	Default: FALSE
 
 min_pmtu - INTEGER
-	default 552 - minimum discovered Path MTU
+	default 552 - minimum Path MTU. Unless this is changed mannually,
+	each cached pmtu will never be lower than this setting.
 
 ip_forward_use_pmtu - BOOLEAN
 	By default we don't trust protocol path MTUs while forwarding

-- 
2.25.1

Hello:

This patch was applied to netdev/net.git (master)
by David S. Miller [off-list ref]:

On Thu, 30 Dec 2021 03:28:56 +0000 you wrote:

From: xu xin <redacted>

The updating way of pmtu has changed, but documentation is still in the
old way. So this patch updates the interpretation of ip_no_pmtu_disc and
min_pmtu.

See commit 28d35bcdd3925 ("net: ipv4: don't let PMTU updates increase
route MTU")

[...]

Here is the summary with links:
  - [v2] Documentation: fix outdated interpretation of ip_no_pmtu_disc
    https://git.kernel.org/netdev/net/c/be1c5b53227b

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html