| Message ID | 20240528140652.9445-4-donald.hunter@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | cb7351ac17862cf8d4e00831ce4aa27f53bda01c |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | doc: netlink: Fixes for ynl doc generator | expand |
On Tue, May 28, 2024 at 03:06:51PM +0100, Donald Hunter wrote: > Generate op flags as an inline list instead of a stringified python > value. > > Signed-off-by: Donald Hunter <donald.hunter@gmail.com> > --- > tools/net/ynl/ynl-gen-rst.py | 4 +++- > 1 file changed, 3 insertions(+), 1 deletion(-) > > diff --git a/tools/net/ynl/ynl-gen-rst.py b/tools/net/ynl/ynl-gen-rst.py > index 1096a71d7867..a957725b20dc 100755 > --- a/tools/net/ynl/ynl-gen-rst.py > +++ b/tools/net/ynl/ynl-gen-rst.py > @@ -172,7 +172,7 @@ def parse_do_attributes(attrs: Dict[str, Any], level: int = 0) -> str: > > def parse_operations(operations: List[Dict[str, Any]], namespace: str) -> str: > """Parse operations block""" > - preprocessed = ["name", "doc", "title", "do", "dump"] > + preprocessed = ["name", "doc", "title", "do", "dump", "flags"] > linkable = ["fixed-header", "attribute-set"] > lines = [] > > @@ -188,6 +188,8 @@ def parse_operations(operations: List[Dict[str, Any]], namespace: str) -> str: > if key in linkable: > value = rst_ref(namespace, key, value) > lines.append(rst_fields(key, value, 0)) > + if 'flags' in operation: You probably want to use double quotes (") as the other cases ("do" and "dump"). Other than that: 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 1096a71d7867..a957725b20dc 100755 --- a/tools/net/ynl/ynl-gen-rst.py +++ b/tools/net/ynl/ynl-gen-rst.py @@ -172,7 +172,7 @@ def parse_do_attributes(attrs: Dict[str, Any], level: int = 0) -> str: def parse_operations(operations: List[Dict[str, Any]], namespace: str) -> str: """Parse operations block""" - preprocessed = ["name", "doc", "title", "do", "dump"] + preprocessed = ["name", "doc", "title", "do", "dump", "flags"] linkable = ["fixed-header", "attribute-set"] lines = [] @@ -188,6 +188,8 @@ def parse_operations(operations: List[Dict[str, Any]], namespace: str) -> str: if key in linkable: value = rst_ref(namespace, key, value) lines.append(rst_fields(key, value, 0)) + if 'flags' in operation: + lines.append(rst_fields('flags', rst_list_inline(operation['flags']))) if "do" in operation: lines.append(rst_paragraph(":do:", 0))
Generate op flags as an inline list instead of a stringified python value. Signed-off-by: Donald Hunter <donald.hunter@gmail.com> --- tools/net/ynl/ynl-gen-rst.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)