| Message ID | 20240528140652.9445-3-donald.hunter@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | ebf9004136c76b7b62fe628a4bc88b3e894b4b95 |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | doc: netlink: Fixes for ynl doc generator | expand |
On Tue, 28 May 2024 15:06:50 +0100 Donald Hunter wrote: > name: pin-get > doc: | > Get list of pins and its attributes. > + > - dump request without any attributes given - list all the pins in the > system > - dump request with target dpll - list all the pins registered with This actually gets rendered as a list now, nice!
diff --git a/Documentation/netlink/specs/dpll.yaml b/Documentation/netlink/specs/dpll.yaml index 95b0eb1486bf..94132d30e0e0 100644 --- a/Documentation/netlink/specs/dpll.yaml +++ b/Documentation/netlink/specs/dpll.yaml @@ -479,6 +479,7 @@ operations: name: pin-get doc: | Get list of pins and its attributes. + - dump request without any attributes given - list all the pins in the system - dump request with target dpll - list all the pins registered with diff --git a/tools/net/ynl/ynl-gen-rst.py b/tools/net/ynl/ynl-gen-rst.py index 5c7465d6befa..1096a71d7867 100755 --- a/tools/net/ynl/ynl-gen-rst.py +++ b/tools/net/ynl/ynl-gen-rst.py @@ -178,7 +178,7 @@ def parse_operations(operations: List[Dict[str, Any]], namespace: str) -> str: for operation in operations: lines.append(rst_section(namespace, 'operation', operation["name"])) - lines.append(rst_paragraph(sanitize(operation["doc"])) + "\n") + lines.append(rst_paragraph(operation["doc"]) + "\n") for key in operation.keys(): if key in preprocessed:
The doc strings for do/dump ops are emitted as toplevel .rst constructs so they can be multi-line. Pass multi-line text straight through to the .rst to retain any simple formatting from the .yaml This fixes e.g. list formatting for the pin-get docs in dpll.yaml: https://docs.kernel.org/6.9/networking/netlink_spec/dpll.html#pin-get Signed-off-by: Donald Hunter <donald.hunter@gmail.com> --- Documentation/netlink/specs/dpll.yaml | 1 + tools/net/ynl/ynl-gen-rst.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)