netdev - [PATCH net-next v3 0/3] tools: ynl: rst: display attribute-set doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20250913-net-next-ynl-attr-doc-rst-v3-0-4f06420d87db@kernel.org>
Date: Sat, 13 Sep 2025 15:29:50 +0200
From: "Matthieu Baerts (NGI0)" <matttbe@...nel.org>
To: Jonathan Corbet <corbet@....net>, 
 Donald Hunter <donald.hunter@...il.com>, Jakub Kicinski <kuba@...nel.org>, 
 "David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>, 
 Paolo Abeni <pabeni@...hat.com>, Simon Horman <horms@...nel.org>, 
 Jiri Pirko <jiri@...nulli.us>
Cc: linux-doc@...r.kernel.org, netdev@...r.kernel.org, 
 linux-kernel@...r.kernel.org, "Matthieu Baerts (NGI0)" <matttbe@...nel.org>, 
 Chuck Lever <chuck.lever@...cle.com>, 
 Jacob Keller <jacob.e.keller@...el.com>, Florian Westphal <fw@...len.de>, 
 Ido Schimmel <idosch@...dia.com>
Subject: [PATCH net-next v3 0/3] tools: ynl: rst: display attribute-set doc

Some attribute-set have a documentation (doc:), but they are not
displayed in the RST / HTML version. This series adds the missing
parsing of these 'doc' fields.

While at it, it also fixes how the 'doc' fields are declared on multiple
lines.

Signed-off-by: Matthieu Baerts (NGI0) <matttbe@...nel.org>
---
Changes in v3:
- patch 2: avoid warnings reported by the CI (NIPA/Jakub)
- Link to v2: https://lore.kernel.org/r/20250912-net-next-ynl-attr-doc-rst-v2-0-c44d36a99992@kernel.org

Changes in v2:
- patch 2 & 3: new
- Link to v1: https://lore.kernel.org/r/20250910-net-next-ynl-attr-doc-rst-v1-1-0bbc77816174@kernel.org

---
Matthieu Baerts (NGI0) (3):
      tools: ynl: rst: display attribute-set doc
      netlink: specs: team: avoid mangling multilines doc
      netlink: specs: explicitly declare block scalar strings

 Documentation/netlink/specs/conntrack.yaml    |  2 +-
 Documentation/netlink/specs/netdev.yaml       | 22 +++++++++++-----------
 Documentation/netlink/specs/nftables.yaml     |  2 +-
 Documentation/netlink/specs/nl80211.yaml      |  2 +-
 Documentation/netlink/specs/ovs_datapath.yaml |  2 +-
 Documentation/netlink/specs/ovs_flow.yaml     |  2 +-
 Documentation/netlink/specs/ovs_vport.yaml    |  2 +-
 Documentation/netlink/specs/rt-addr.yaml      |  2 +-
 Documentation/netlink/specs/rt-link.yaml      |  2 +-
 Documentation/netlink/specs/rt-neigh.yaml     |  2 +-
 Documentation/netlink/specs/rt-route.yaml     |  2 +-
 Documentation/netlink/specs/rt-rule.yaml      |  2 +-
 Documentation/netlink/specs/tc.yaml           |  2 +-
 Documentation/netlink/specs/team.yaml         |  6 ++++--
 tools/net/ynl/pyynl/lib/doc_generator.py      |  4 ++++
 15 files changed, 31 insertions(+), 25 deletions(-)
---
base-commit: fc006f5478fcf07d79b35e9dcdc51ecd11a6bf82
change-id: 20250910-net-next-ynl-attr-doc-rst-b61532634245

Best regards,
-- 
Matthieu Baerts (NGI0) <matttbe@...nel.org>