| Message ID | 20240123160538.172-12-donald.hunter@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | tools/net/ynl: Add features for tc family | expand |
On Tue, Jan 23, 2024 at 04:05:37PM +0000, Donald Hunter wrote: > Extend the ynl doc generator to include type information for struct > members, ignoring the pad type. > > Signed-off-by: Donald Hunter <donald.hunter@gmail.com> > --- > tools/net/ynl/ynl-gen-rst.py | 10 +++++++++- > 1 file changed, 9 insertions(+), 1 deletion(-) > > diff --git a/tools/net/ynl/ynl-gen-rst.py b/tools/net/ynl/ynl-gen-rst.py > index 262d88f88696..75c969d36b6a 100755 > --- a/tools/net/ynl/ynl-gen-rst.py > +++ b/tools/net/ynl/ynl-gen-rst.py > @@ -189,12 +189,20 @@ def parse_operations(operations: List[Dict[str, Any]]) -> str: > > def parse_entries(entries: List[Dict[str, Any]], level: int) -> str: > """Parse a list of entries""" > + ignored = ["pad"] > lines = [] > for entry in entries: > if isinstance(entry, dict): > # entries could be a list or a dictionary > + field_name = entry.get("name", "") > + if field_name in ignored: > + continue > + type_ = entry.get("type") > + struct_ = entry.get("struct") Where are you using this `struct_` variable ? Rest of the code it looks good.
diff --git a/tools/net/ynl/ynl-gen-rst.py b/tools/net/ynl/ynl-gen-rst.py index 262d88f88696..75c969d36b6a 100755 --- a/tools/net/ynl/ynl-gen-rst.py +++ b/tools/net/ynl/ynl-gen-rst.py @@ -189,12 +189,20 @@ def parse_operations(operations: List[Dict[str, Any]]) -> str: def parse_entries(entries: List[Dict[str, Any]], level: int) -> str: """Parse a list of entries""" + ignored = ["pad"] lines = [] for entry in entries: if isinstance(entry, dict): # entries could be a list or a dictionary + field_name = entry.get("name", "") + if field_name in ignored: + continue + type_ = entry.get("type") + struct_ = entry.get("struct") + if type_: + field_name += f" ({inline(type_)})" lines.append( - rst_fields(entry.get("name", ""), sanitize(entry.get("doc", "")), level) + rst_fields(field_name, sanitize(entry.get("doc", "")), level) ) elif isinstance(entry, list): lines.append(rst_list_inline(entry, level))
Extend the ynl doc generator to include type information for struct members, ignoring the pad type. Signed-off-by: Donald Hunter <donald.hunter@gmail.com> --- tools/net/ynl/ynl-gen-rst.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-)