| Message ID | 20240528140652.9445-2-donald.hunter@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | c697f515b6390b17e4a54a6f93aedf27133929c5 |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | doc: netlink: Fixes for ynl doc generator | expand |
On Tue, May 28, 2024 at 03:06:49PM +0100, Donald Hunter wrote: > 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> Reviwed-by: Breno Leitao <leitao@debian.org>
diff --git a/tools/net/ynl/ynl-gen-rst.py b/tools/net/ynl/ynl-gen-rst.py index 657e881d2ea4..5c7465d6befa 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:
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> --- tools/net/ynl/ynl-gen-rst.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)