Skip to contentSkip to conversation

Another ip-sysctl docs cleanup

PATCH Applied Bagas Sanjaya 3 participants 12 messages Jul 1, 2025 – Jul 3, 2025

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

cover Another ip-sysctl docs cleanup

Inspired by Abdelrahman's cleanup [1]. This time, mostly formatting conversion to bullet lists.

[1]: https://lore.kernel.org/linux-doc/[email protected]/

Bagas Sanjaya (5):
net: ip-sysctl: Format Private VLAN proxy arp aliases as bullet list
net: ip-sysctl: Format possible value range of ioam6_id{,_wide} as
bullet list
net: ip-sysctl: Format pf_{enable,expose} boolean lists as bullet
lists
net: ip-sysctl: Format SCTP-related memory parameters description as
bullet list
net: ip-sysctl: Add link to SCTP IPv4 scoping draft

 Documentation/networking/ip-sysctl.rst | 76 +++++++++++++-------------
 1 file changed, 38 insertions(+), 38 deletions(-)

base-commit: 647496422ba9d2784fb8e15b3fda7fe801b1f2ff

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

PATCH 1/5 net: ip-sysctl: Format Private VLAN proxy arp aliases as bullet list

Alias names list for private VLAN proxy arp technology is formatted as indented paragraph instead. Make it bullet list as it is better fit for this purpose.

---
 Documentation/networking/ip-sysctl.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/networking/ip-sysctl.rst +4 -4
index 9af5a8935d575b..a736035216f9b7 100644
@@ -1891,10 +1891,10 @@ proxy_arp_pvlan - BOOLEAN
 
 	This technology is known by different names:
 
-	  In RFC 3069 it is called VLAN Aggregation.
-	  Cisco and Allied Telesyn call it Private VLAN.
-	  Hewlett-Packard call it Source-Port filtering or port-isolation.
-	  Ericsson call it MAC-Forced Forwarding (RFC Draft).
+	- In RFC 3069 it is called VLAN Aggregation.
+	- Cisco and Allied Telesyn call it Private VLAN.
+	- Hewlett-Packard call it Source-Port filtering or port-isolation.
+	- Ericsson call it MAC-Forced Forwarding (RFC Draft).
 
 proxy_delay - INTEGER
 	Delay proxy response.
Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Reviewed-by on v1 1/5
#2 lore raw

Re: [PATCH net-next 1/5] net: ip-sysctl: Format Private VLAN proxy arp aliases as bullet list

Quoted 5 lines · Bagas Sanjaya

Alias names list for private VLAN proxy arp technology is formatted as indented paragraph instead. Make it bullet list as it is better fit for this purpose.

#3 lore raw

PATCH 2/5 net: ip-sysctl: Format possible value range of ioam6_id{,_wide} as bullet list

In reply to Bagas Sanjaya

Format possible value range bounds of ioam6_id and ioam6_id_wide as bullet list instead of running paragraph.

---
 Documentation/networking/ip-sysctl.rst | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)
Documentation/networking/ip-sysctl.rst +8 -4
index a736035216f9b7..6c2bb3347885c3 100644
@@ -2487,8 +2487,10 @@ fib_notify_on_flag_change - INTEGER
 ioam6_id - INTEGER
         Define the IOAM id of this node. Uses only 24 bits out of 32 in total.
 
-        Min: 0
-        Max: 0xFFFFFF
+        Possible value range:
+
+        - Min: 0
+        - Max: 0xFFFFFF
 
         Default: 0xFFFFFF
 
@@ -2496,8 +2498,10 @@ ioam6_id_wide - LONG INTEGER
         Define the wide IOAM id of this node. Uses only 56 bits out of 64 in
         total. Can be different from ioam6_id.
 
-        Min: 0
-        Max: 0xFFFFFFFFFFFFFF
+        Possible value range:
+
+        - Min: 0
+        - Max: 0xFFFFFFFFFFFFFF
 
         Default: 0xFFFFFFFFFFFFFF
 
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#5 lore raw

PATCH 3/5 net: ip-sysctl: Format pf_{enable,expose} boolean lists as bullet lists

In reply to Bagas Sanjaya

These lists' items were separated by newlines but without bullet list marker. Turn the lists into proper bullet list.

While at it, also reword values description for pf_expose to not repeat mentioning SCTP_PEER_ADDR_CHANGE and SCTP_GET_PEER_ADDR_INFO sockopt.

---
 Documentation/networking/ip-sysctl.rst | 28 +++++++++++---------------
 1 file changed, 12 insertions(+), 16 deletions(-)
Documentation/networking/ip-sysctl.rst +12 -16
index 6c2bb3347885c3..774fbf462ccd65 100644
@@ -3326,31 +3326,27 @@ pf_enable - INTEGER
 	https://datatracker.ietf.org/doc/draft-ietf-tsvwg-sctp-failover for
 	details.
 
-	1: Enable pf.
+	Possible values:
 
-	0: Disable pf.
+	- 1: Enable pf.
+	- 0: Disable pf.
 
 	Default: 1
 
 pf_expose - INTEGER
 	Unset or enable/disable pf (pf is short for potentially failed) state
 	exposure.  Applications can control the exposure of the PF path state
-	in the SCTP_PEER_ADDR_CHANGE event and the SCTP_GET_PEER_ADDR_INFO
-	sockopt.   When it's unset, no SCTP_PEER_ADDR_CHANGE event with
-	SCTP_ADDR_PF state will be sent and a SCTP_PF-state transport info
-	can be got via SCTP_GET_PEER_ADDR_INFO sockopt;  When it's enabled,
-	a SCTP_PEER_ADDR_CHANGE event will be sent for a transport becoming
-	SCTP_PF state and a SCTP_PF-state transport info can be got via
-	SCTP_GET_PEER_ADDR_INFO sockopt;  When it's disabled, no
-	SCTP_PEER_ADDR_CHANGE event will be sent and it returns -EACCES when
-	trying to get a SCTP_PF-state transport info via SCTP_GET_PEER_ADDR_INFO
-	sockopt.
+	in the SCTP_PEER_ADDR_CHANGE event and access of SCTP_PF-state
+	transport info via SCTP_GET_PEER_ADDR_INFO sockopt.
 
-	0: Unset pf state exposure, Compatible with old applications.
+	Possible values:
 
-	1: Disable pf state exposure.
-
-	2: Enable pf state exposure.
+	- 0: Unset pf state exposure (compatible with old applications). No
+	  event will be sent but the transport info can be queried.
+	- 1: Disable pf state exposure. No event will be sent and trying to
+	  obtain transport info will return -EACCESS.
+	- 2: Enable pf state exposure. The event will be sent for a transport
+	  becoming SCTP_PF state and transport info can be obtained.
 
 	Default: 0
 
Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Reviewed-by on v1 3/5
#6 lore raw

Re: [PATCH net-next 3/5] net: ip-sysctl: Format pf_{enable,expose} boolean lists as bullet lists

Quoted 7 lines · Bagas Sanjaya

These lists' items were separated by newlines but without bullet list marker. Turn the lists into proper bullet list.

While at it, also reword values description for pf_expose to not repeat mentioning SCTP_PEER_ADDR_CHANGE and SCTP_GET_PEER_ADDR_INFO sockopt.

#7 lore raw

PATCH 4/5 net: ip-sysctl: Format SCTP-related memory parameters description as bullet list

In reply to Bagas Sanjaya

The description for vector elements of SCTP-related memory usage parameters (sctp{r,w,}mem) is formatted as normal paragraphs rather than bullet list. Convert the description to the latter.

---
 Documentation/networking/ip-sysctl.rst | 24 +++++++++++-------------
 1 file changed, 11 insertions(+), 13 deletions(-)
Documentation/networking/ip-sysctl.rst +11 -13
index 774fbf462ccd65..12c8a236456e4e 100644
@@ -3542,13 +3542,11 @@ sndbuf_policy - INTEGER
 sctp_mem - vector of 3 INTEGERs: min, pressure, max
 	Number of pages allowed for queueing by all SCTP sockets.
 
-	min: Below this number of pages SCTP is not bothered about its
-	memory appetite. When amount of memory allocated by SCTP exceeds
-	this number, SCTP starts to moderate memory usage.
-
-	pressure: This value was introduced to follow format of tcp_mem.
-
-	max: Number of pages allowed for queueing by all SCTP sockets.
+	* min: Below this number of pages SCTP is not bothered about its
+	  memory usage. When amount of memory allocated by SCTP exceeds
+	  this number, SCTP starts to moderate memory usage.
+	* pressure: This value was introduced to follow format of tcp_mem.
+	* max: Maximum number of allowed pages.
 
 	Default is calculated at boot time from amount of available memory.
 
@@ -3556,9 +3554,9 @@ sctp_rmem - vector of 3 INTEGERs: min, default, max
 	Only the first value ("min") is used, "default" and "max" are
 	ignored.
 
-	min: Minimal size of receive buffer used by SCTP socket.
-	It is guaranteed to each SCTP socket (but not association) even
-	under moderate memory pressure.
+	* min: Minimal size of receive buffer used by SCTP socket.
+	  It is guaranteed to each SCTP socket (but not association) even
+	  under moderate memory pressure.
 
 	Default: 4K
 
@@ -3566,9 +3564,9 @@ sctp_wmem  - vector of 3 INTEGERs: min, default, max
 	Only the first value ("min") is used, "default" and "max" are
 	ignored.
 
-	min: Minimum size of send buffer that can be used by SCTP sockets.
-	It is guaranteed to each SCTP socket (but not association) even
-	under moderate memory pressure.
+	* min: Minimum size of send buffer that can be used by SCTP sockets.
+	  It is guaranteed to each SCTP socket (but not association) even
+	  under moderate memory pressure.
 
 	Default: 4K
 
Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Reviewed-by on v1 4/5
#8 lore raw

Re: [PATCH net-next 4/5] net: ip-sysctl: Format SCTP-related memory parameters description as bullet list

Quoted 6 lines · Bagas Sanjaya

The description for vector elements of SCTP-related memory usage parameters (sctp{r,w,}mem) is formatted as normal paragraphs rather than bullet list. Convert the description to the latter.

---

#9 lore raw

PATCH 5/5 net: ip-sysctl: Add link to SCTP IPv4 scoping draft

In reply to Bagas Sanjaya

addr_scope_policy description contains pointer to SCTP IPv4 scoping draft but not its IETF Datatracker link. Add it.

---
 Documentation/networking/ip-sysctl.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
Documentation/networking/ip-sysctl.rst +3 -1
index 12c8a236456e4e..2cad74e18f717d 100644
@@ -3571,7 +3571,9 @@ sctp_wmem  - vector of 3 INTEGERs: min, default, max
 	Default: 4K
 
 addr_scope_policy - INTEGER
-	Control IPv4 address scoping - draft-stewart-tsvwg-sctp-ipv4-00
+	Control IPv4 address scoping (see
+	https://datatracker.ietf.org/doc/draft-stewart-tsvwg-sctp-ipv4/00/
+	for details).
 
 	- 0   - Disable IPv4 address scoping
 	- 1   - Enable IPv4 address scoping
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#11 lore raw
In reply to Bagas Sanjaya
This series was applied to netdev/net-next.git (main) by Paolo Abeni <[email protected]>:

Hello:

This series was applied to netdev/net-next.git (main) by Paolo Abeni <[email protected]>:

Quoted 15 lines · On Tue, 1 Jul 2025 10:12:55 +0700 you wrote:

Inspired by Abdelrahman's cleanup [1]. This time, mostly formatting conversion to bullet lists.

[1]: https://lore.kernel.org/linux-doc/[email protected]/

Bagas Sanjaya (5):
net: ip-sysctl: Format Private VLAN proxy arp aliases as bullet list
net: ip-sysctl: Format possible value range of ioam6_id{,_wide} as
bullet list
net: ip-sysctl: Format pf_{enable,expose} boolean lists as bullet
lists
net: ip-sysctl: Format SCTP-related memory parameters description as
bullet list
net: ip-sysctl: Add link to SCTP IPv4 scoping draft

Quoted 1 line

[...]

Here is the summary with links:
- [net-next,1/5] net: ip-sysctl: Format Private VLAN proxy arp aliases as bullet list

    https://git.kernel.org/netdev/net-next/c/501aeb1ef463
  - [net-next,2/5] net: ip-sysctl: Format possible value range of ioam6_id{,_wide} as bullet list
    https://git.kernel.org/netdev/net-next/c/2040058db302
  - [net-next,3/5] net: ip-sysctl: Format pf_{enable,expose} boolean lists as bullet lists
    https://git.kernel.org/netdev/net-next/c/98bc1d41f2c5
  - [net-next,4/5] net: ip-sysctl: Format SCTP-related memory parameters description as bullet list
    https://git.kernel.org/netdev/net-next/c/82b056600059
  - [net-next,5/5] net: ip-sysctl: Add link to SCTP IPv4 scoping draft
    https://git.kernel.org/netdev/net-next/c/2f1fa26eef65

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html