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

Message

Donald Hunter May 28, 2024, 2:06 p.m. UTC

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(-)

Comments

[e-mail] May 30, 2024, 2 a.m. UTC | #1

Hello:

This series was applied to netdev/net-next.git (main)
by Jakub Kicinski <[e-mail]>:

On Tue, 28 May 2024 15:06:48 +0100 you wrote:
> 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
> 
> [...]

Here is the summary with links:
  - [net-next,v1,1/4] doc: netlink: Fix generated .rst for multi-line docs
    https://git.kernel.org/netdev/net-next/c/c697f515b639
  - [net-next,v1,2/4] doc: netlink: Don't 'sanitize' op docstrings in generated .rst
    https://git.kernel.org/netdev/net-next/c/ebf9004136c7
  - [net-next,v1,3/4] doc: netlink: Fix formatting of op flags in generated .rst
    https://git.kernel.org/netdev/net-next/c/cb7351ac1786
  - [net-next,v1,4/4] doc: netlink: Fix op pre and post fields in generated .rst
    https://git.kernel.org/netdev/net-next/c/9104feed4c64

You are awesome, thank you!