| Message ID | 20240528140652.9445-5-donald.hunter@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 9104feed4c6454b9a720e7e11047be7e5cd83487 |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | doc: netlink: Fixes for ynl doc generator | expand |
On Tue, May 28, 2024 at 03:06:52PM +0100, Donald Hunter wrote: > The generated .rst has pre and post headings without any values, e.g. > here: > > https://docs.kernel.org/6.9/networking/netlink_spec/dpll.html#device-id-get > > Emit keys and values in the generated .rst > > Signed-off-by: Donald Hunter <donald.hunter@gmail.com> Reviwed-by: Breno Leitao <leitao@debian.org>
On Tue, 28 May 2024 15:06:52 +0100 Donald Hunter wrote: > The generated .rst has pre and post headings without any values, e.g. > here: > > https://docs.kernel.org/6.9/networking/netlink_spec/dpll.html#device-id-get > > Emit keys and values in the generated .rst I think your patch still stands (in case there is more such attrs) but for pre and post in particular - we can hide them completely. They are annotations used only by the kernel code gen, there's no need to display them in the docs.
Jakub Kicinski <kuba@kernel.org> writes: > On Tue, 28 May 2024 15:06:52 +0100 Donald Hunter wrote: >> The generated .rst has pre and post headings without any values, e.g. >> here: >> >> https://docs.kernel.org/6.9/networking/netlink_spec/dpll.html#device-id-get >> >> Emit keys and values in the generated .rst > > I think your patch still stands (in case there is more such attrs) but > for pre and post in particular - we can hide them completely. They are > annotations used only by the kernel code gen, there's no need to > display them in the docs. Yep, I wondered about that. I'll look at suppressing pre and post in a followup.
diff --git a/tools/net/ynl/ynl-gen-rst.py b/tools/net/ynl/ynl-gen-rst.py index a957725b20dc..6c56d0d726b4 100755 --- a/tools/net/ynl/ynl-gen-rst.py +++ b/tools/net/ynl/ynl-gen-rst.py @@ -156,7 +156,10 @@ def parse_do(do_dict: Dict[str, Any], level: int = 0) -> str: lines = [] for key in do_dict.keys(): lines.append(rst_paragraph(bold(key), level + 1)) - lines.append(parse_do_attributes(do_dict[key], level + 1) + "\n") + if key in ['request', 'reply']: + lines.append(parse_do_attributes(do_dict[key], level + 1) + "\n") + else: + lines.append(headroom(level + 2) + do_dict[key] + "\n") return "\n".join(lines)
The generated .rst has pre and post headings without any values, e.g. here: https://docs.kernel.org/6.9/networking/netlink_spec/dpll.html#device-id-get Emit keys and values in the generated .rst Signed-off-by: Donald Hunter <donald.hunter@gmail.com> --- tools/net/ynl/ynl-gen-rst.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)