From: Donald Hunter Date: Tue, 28 May 2024 14:06:49 +0000 (+0100) Subject: doc: netlink: Fix generated .rst for multi-line docs X-Git-Tag: v6.11-rc1~163^2~293^2~3 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c697f515b6390b17e4a54a6f93aedf27133929c5;p=thirdparty%2Fkernel%2Flinux.git doc: netlink: Fix generated .rst for multi-line docs 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 Link: https://lore.kernel.org/r/20240528140652.9445-2-donald.hunter@gmail.com Signed-off-by: Jakub Kicinski --- diff --git a/tools/net/ynl/ynl-gen-rst.py b/tools/net/ynl/ynl-gen-rst.py index 657e881d2ea4a..5c7465d6befa0 100755 --- a/tools/net/ynl/ynl-gen-rst.py +++ b/tools/net/ynl/ynl-gen-rst.py @@ -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: