Commit fe09ae5f authored by Donald Hunter's avatar Donald Hunter Committed by Jakub Kicinski
Browse files

tools/net/ynl: Add type info to struct members in generated docs 



Extend the ynl doc generator to include type information for struct
members, ignoring the pad type.

Signed-off-by: default avatarDonald Hunter <donald.hunter@gmail.com>
Reviewed-by: default avatarJiri Pirko <jiri@nvidia.com>
Link: https://lore.kernel.org/r/20240129223458.52046-13-donald.hunter@gmail.com


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 9d6429c3

tools/net/ynl/ynl-gen-rst.py

+8 −1
Original line number Diff line number Diff line
@@ -189,12 +189,19 @@ 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")

            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))