netdev - [PATCH net-next v1 0/4] doc: netlink: Fixes for ynl doc generator

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: <20240528140652.9445-1-donald.hunter@gmail.com>
Date: Tue, 28 May 2024 15:06:48 +0100
From: Donald Hunter <donald.hunter@...il.com>
To: netdev@...r.kernel.org,
	Jakub Kicinski <kuba@...nel.org>,
	"David S. Miller" <davem@...emloft.net>,
	Eric Dumazet <edumazet@...gle.com>,
	Paolo Abeni <pabeni@...hat.com>,
	Jiri Pirko <jiri@...nulli.us>,
	Breno Leitao <leitao@...ian.org>,
	Arkadiusz Kubalewski <arkadiusz.kubalewski@...el.com>,
	Vadim Fedorenko <vadim.fedorenko@...ux.dev>
Cc: donald.hunter@...hat.com,
	Donald Hunter <donald.hunter@...il.com>
Subject: [PATCH net-next v1 0/4] doc: netlink: Fixes for ynl doc generator

Several fixes to ynl-gen-rst to resolve issues that can be seen
in:

https://docs.kernel.org/6.10-rc1/networking/netlink_spec/dpll.html#device-id-get
https://docs.kernel.org/6.10-rc1/networking/netlink_spec/dpll.html#lock-status

In patch 2, by not using 'sanitize' for op docs, any formatting in the
.yaml gets passed straight through to the generated .rst which means
that basic rst (also markdown compatible) list formatting can be used in
the .yaml

Donald Hunter (4):
  doc: netlink: Fix generated .rst for multi-line docs
  doc: netlink: Don't 'sanitize' op docstrings in generated .rst
  doc: netlink: Fix formatting of op flags in generated .rst
  doc: netlink: Fix op pre and post fields in generated .rst

 Documentation/netlink/specs/dpll.yaml |  1 +
 tools/net/ynl/ynl-gen-rst.py          | 13 +++++++++----
 2 files changed, 10 insertions(+), 4 deletions(-)

-- 
2.44.0