From: Donald Hunter <donald.hunter@gmail.com>
To: netdev@vger.kernel.org, Jakub Kicinski <kuba@kernel.org>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Paolo Abeni <pabeni@redhat.com>, Jiri Pirko <jiri@resnulli.us>,
Breno Leitao <leitao@debian.org>,
Arkadiusz Kubalewski <arkadiusz.kubalewski@intel.com>,
Vadim Fedorenko <vadim.fedorenko@linux.dev>
Cc: donald.hunter@redhat.com, Donald Hunter <donald.hunter@gmail.com>
Subject: [PATCH net-next v1 4/4] doc: netlink: Fix op pre and post fields in generated .rst
Date: Tue, 28 May 2024 15:06:52 +0100 [thread overview]
Message-ID: <20240528140652.9445-5-donald.hunter@gmail.com> (raw)
In-Reply-To: <20240528140652.9445-1-donald.hunter@gmail.com>
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(-)
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)
--
2.44.0
next prev parent reply other threads:[~2024-05-28 14:07 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-28 14:06 [PATCH net-next v1 0/4] doc: netlink: Fixes for ynl doc generator Donald Hunter
2024-05-28 14:06 ` [PATCH net-next v1 1/4] doc: netlink: Fix generated .rst for multi-line docs Donald Hunter
2024-05-28 14:35 ` Breno Leitao
2024-05-28 14:06 ` [PATCH net-next v1 2/4] doc: netlink: Don't 'sanitize' op docstrings in generated .rst Donald Hunter
2024-05-30 1:04 ` Jakub Kicinski
2024-05-28 14:06 ` [PATCH net-next v1 3/4] doc: netlink: Fix formatting of op flags " Donald Hunter
2024-05-28 14:27 ` Breno Leitao
2024-05-28 14:06 ` Donald Hunter [this message]
2024-05-28 14:25 ` [PATCH net-next v1 4/4] doc: netlink: Fix op pre and post fields " Breno Leitao
2024-05-30 1:10 ` Jakub Kicinski
2024-05-30 10:42 ` Donald Hunter
2024-05-30 2:00 ` [PATCH net-next v1 0/4] doc: netlink: Fixes for ynl doc generator patchwork-bot+netdevbpf
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240528140652.9445-5-donald.hunter@gmail.com \
--to=donald.hunter@gmail.com \
--cc=arkadiusz.kubalewski@intel.com \
--cc=davem@davemloft.net \
--cc=donald.hunter@redhat.com \
--cc=edumazet@google.com \
--cc=jiri@resnulli.us \
--cc=kuba@kernel.org \
--cc=leitao@debian.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=vadim.fedorenko@linux.dev \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.