Skip to contentSkip to conversation

tools: ynl: render event op docs correctly

PATCH Applied Donald Hunter 2 participants 2 messages Jan 12 – Jan 14

Subsystems (4)
lore
Share & tools
lore

Donald Hunter

author maintainer
#0 lore raw

PATCH 1/1 tools: ynl: render event op docs correctly

The docs for YNL event ops currently render raw python structs. For example in:

https://docs.kernel.org/netlink/specs/ethtool.html#cable-test-ntf

event: {‘attributes’: [‘header’, ‘status’, ‘nest’], ‘__lineno__’: 2385}

Handle event ops correctly and render their op attributes:

event: attributes: [header, status]

---
 tools/net/ynl/pyynl/lib/doc_generator.py | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
tools/net/ynl/pyynl/lib/doc_generator.py +6 -3
index 3a16b8eb01ca..8b922d8f89e8 100644
@@ -166,13 +166,13 @@ class YnlDocGenerator:
                 continue
             lines.append(self.fmt.rst_paragraph(self.fmt.bold(key), level + 1))
             if key in ['request', 'reply']:
-                lines.append(self.parse_do_attributes(do_dict[key], level + 1) + "\n")
+                lines.append(self.parse_op_attributes(do_dict[key], level + 1) + "\n")
             else:
                 lines.append(self.fmt.headroom(level + 2) + do_dict[key] + "\n")
 
         return "\n".join(lines)
 
-    def parse_do_attributes(self, attrs: Dict[str, Any], level: int = 0) -> str:
+    def parse_op_attributes(self, attrs: Dict[str, Any], level: int = 0) -> str:
         """Parse 'attributes' section"""
         if "attributes" not in attrs:
             return ""
@@ -184,7 +184,7 @@ class YnlDocGenerator:
 
     def parse_operations(self, operations: List[Dict[str, Any]], namespace: str) -> str:
         """Parse operations block"""
-        preprocessed = ["name", "doc", "title", "do", "dump", "flags"]
+        preprocessed = ["name", "doc", "title", "do", "dump", "flags", "event"]
         linkable = ["fixed-header", "attribute-set"]
         lines = []
 
@@ -217,6 +217,9 @@ class YnlDocGenerator:
             if "dump" in operation:
                 lines.append(self.fmt.rst_paragraph(":dump:", 0))
                 lines.append(self.parse_do(operation["dump"], 0))
+            if "event" in operation:
+                lines.append(self.fmt.rst_paragraph(":event:", 0))
+                lines.append(self.parse_op_attributes(operation["event"], 0))
 
             # New line after fields
             lines.append("\n")
Signature · 1 line
2.52.0
#1 lore raw
This patch was applied to netdev/net.git (main) by Jakub Kicinski <[email protected]>:

Hello:

This patch was applied to netdev/net.git (main)
by Jakub Kicinski <[email protected]>:

Quoted 8 lines · On Mon, 12 Jan 2026 15:34:36 +0000 you wrote:

The docs for YNL event ops currently render raw python structs. For example in:

https://docs.kernel.org/netlink/specs/ethtool.html#cable-test-ntf

event: {‘attributes’: [‘header’, ‘status’, ‘nest’], ‘__lineno__’: 2385}

[...]

Here is the summary with links:
- [net,v1] tools: ynl: render event op docs correctly

    https://git.kernel.org/netdev/net/c/fa5726692e4c

You are awesome, thank you!

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