]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
doc: netlink: Fix generated .rst for multi-line docs
authorDonald Hunter <donald.hunter@gmail.com>
Tue, 28 May 2024 14:06:49 +0000 (15:06 +0100)
committerJakub Kicinski <kuba@kernel.org>
Thu, 30 May 2024 01:10:25 +0000 (18:10 -0700)
Fix the newline replacement in ynl-gen-rst.py to put spaces between
concatenated lines. This fixes the broken doc string formatting.

See the dpll docs for an example of broken concatenation:

https://docs.kernel.org/6.9/networking/netlink_spec/dpll.html#lock-status

Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
Link: https://lore.kernel.org/r/20240528140652.9445-2-donald.hunter@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
tools/net/ynl/ynl-gen-rst.py

index 657e881d2ea4a571a2cebbc1b9465a04ab21d804..5c7465d6befa022f3c281b17737e942e764ed0f1 100755 (executable)
@@ -49,7 +49,7 @@ def inline(text: str) -> str:
 def sanitize(text: str) -> str:
     """Remove newlines and multiple spaces"""
     # This is useful for some fields that are spread across multiple lines
-    return str(text).replace("\n", "").strip()
+    return str(text).replace("\n", " ").strip()
 
 
 def rst_fields(key: str, value: str, level: int = 0) -> str: