mirrors
/
linux-stable
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Releases Wiki Activity

tools/net/ynl-gen-rst: Remove extra indentation from generated docs 

The output from ynl-gen-rst.py has extra indentation that causes extra
<blockquote> elements to be generated in the HTML output.

Reduce the indentation so that sphinx doesn't generate unnecessary
<blockquote> elements.

Reviewed-by: Breno Leitao <leitao@debian.org>
Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
Link: https://lore.kernel.org/r/20231215093720.18774-14-donald.hunter@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Donald Hunter 2023-12-15 09:37:20 +00:00 committed by Jakub Kicinski
parent e9d7c59212
commit 9b0aa2244d
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
tools/net/ynl/ynl-gen-rst.py
View File

@ -69,7 +69,7 @@ def rst_paragraph(paragraph: str, level: int = 0) -> str:
def rst_bullet(item: str, level: int = 0) -> str:
"""Return a formatted a bullet"""
return headroom(level) + f" - {item}"
return headroom(level) + f"- {item}"
def rst_subsection(title: str) -> str:
@ -250,7 +250,7 @@ def parse_attr_sets(entries: List[Dict[str, Any]]) -> str:
for k in attr.keys():
if k in preprocessed + ignored:
continue
lines.append(rst_fields(k, sanitize(attr[k]), 2))
lines.append(rst_fields(k, sanitize(attr[k]), 0))
lines.append("\n")
return "\n".join(lines)
@ -268,7 +268,7 @@ def parse_sub_messages(entries: List[Dict[str, Any]]) -> str:
lines.append(rst_bullet(bold(value)))
for attr in ['fixed-header', 'attribute-set']:
if attr in fmt:
lines.append(rst_fields(attr, fmt[attr], 2))
lines.append(rst_fields(attr, fmt[attr], 1))
lines.append("\n")
return "\n".join(lines)