Commit a5a8844a authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

Merge branch 'tools-ynl-rst-display-attribute-set-doc' 

Matthieu Baerts says:

====================
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.
====================

Link: https://patch.msgid.link/20250913-net-next-ynl-attr-doc-rst-v3-0-4f06420d87db@kernel.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parents 7acc8b90 12e74931

Documentation/netlink/specs/conntrack.yaml

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ name: conntrack 
protocol: netlink-raw

protonum: 12



doc:

doc: >-

  Netfilter connection tracking subsystem over nfnetlink



definitions:

Documentation/netlink/specs/netdev.yaml

+11 −11
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
---

name: netdev



doc:

doc: >-

  netdev configuration over generic netlink.



definitions:
@@ -13,33 +13,33 @@ definitions: 
    entries:

      -

        name: basic

        doc:

        doc: >-

          XDP features set supported by all drivers

          (XDP_ABORTED, XDP_DROP, XDP_PASS, XDP_TX)

      -

        name: redirect

        doc:

        doc: >-

          The netdev supports XDP_REDIRECT

      -

        name: ndo-xmit

        doc:

        doc: >-

          This feature informs if netdev implements ndo_xdp_xmit callback.

      -

        name: xsk-zerocopy

        doc:

        doc: >-

          This feature informs if netdev supports AF_XDP in zero copy mode.

      -

        name: hw-offload

        doc:

        doc: >-

          This feature informs if netdev supports XDP hw offloading.

      -

        name: rx-sg

        doc:

        doc: >-

          This feature informs if netdev implements non-linear XDP buffer

          support in the driver napi callback.

      -

        name: ndo-xmit-sg

        doc:

        doc: >-

          This feature informs if netdev implements non-linear XDP buffer

          support in ndo_xdp_xmit callback.

  -
@@ -67,15 +67,15 @@ definitions: 
    entries:

      -

        name: tx-timestamp

        doc:

        doc: >-

          HW timestamping egress packets is supported by the driver.

      -

        name: tx-checksum

        doc:

        doc: >-

          L3 checksum HW offload is supported by the driver.

      -

        name: tx-launch-time-fifo

        doc:

        doc: >-

          Launch time HW offload is supported by the driver.

  -

    name: queue-type

Documentation/netlink/specs/nftables.yaml

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ name: nftables 
protocol: netlink-raw

protonum: 12



doc:

doc: >-

  Netfilter nftables configuration over netlink.



definitions:

Documentation/netlink/specs/nl80211.yaml

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
name: nl80211

protocol: genetlink-legacy



doc:

doc: >-

  Netlink API for 802.11 wireless devices



definitions:

Documentation/netlink/specs/ovs_datapath.yaml

+1 −1
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ version: 2 
protocol: genetlink-legacy

uapi-header: linux/openvswitch.h



doc:

doc: >-

  OVS datapath configuration over generic netlink.



definitions: