github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-23 22:52:19 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

netlink: specs: wrap long doc lines (>80 chars)

Browse Source 
Clean up all line too long errors reported by yamllint in the netlink
specs, e.g.

    error    line too long (97 > 80 characters)  (line-length)

Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
Reviewed-by: Chuck Lever <chuck.lever@oracle.com>
Reviewed-by: Matthieu Baerts (NGI0) <matttbe@kernel.org> # mptcp_pm.yaml
Link: https://patch.msgid.link/20250610125944.85265-7-donald.hunter@gmail.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Donald Hunter 2025-06-10 13:59:43 +01:00 committed by Jakub Kicinski
parent ec362192aa
commit d26552d38c
9 changed files with 51 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/netlink/specs/devlink.yaml
View File

@ -1873,7 +1873,9 @@ operations:
-
name: info-get
doc: Get device information, like driver name, hardware and firmware versions etc.
doc: |
Get device information, like driver name, hardware and firmware versions
etc.
attribute-set: devlink
dont-validate: [strict, dump]
do:

4
Documentation/netlink/specs/ethtool.yaml
View File

@ -55,7 +55,9 @@ definitions:
doc: The firmware flashing process was stopped due to an error.
-
name: c33-pse-ext-state
doc: "groups of PSE extended states functions. IEEE 802.3-2022 33.2.4.4 Variables"
doc: |
"groups of PSE extended states functions. IEEE 802.3-2022 33.2.4.4
Variables"
type: enum
name-prefix: ethtool-c33-pse-ext-state-
header: linux/ethtool.h

4
Documentation/netlink/specs/mptcp_pm.yaml
View File

@ -61,8 +61,8 @@ definitions:
-
name: sub-closed
doc: >-
A subflow has been closed. An error (copy of sk_err) could be set if an
error has been detected for this subflow.
A subflow has been closed. An error (copy of sk_err) could be set if
an error has been detected for this subflow.
Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |
daddr6, sport, dport, backup, if_idx [, error].
-

25
Documentation/netlink/specs/netdev.yaml
View File

@ -48,16 +48,19 @@ definitions:
entries:
-
name: timestamp
doc:
Device is capable of exposing receive HW timestamp via bpf_xdp_metadata_rx_timestamp().
doc: |
Device is capable of exposing receive HW timestamp via
bpf_xdp_metadata_rx_timestamp().
-
name: hash
doc:
Device is capable of exposing receive packet hash via bpf_xdp_metadata_rx_hash().
doc: |
Device is capable of exposing receive packet hash via
bpf_xdp_metadata_rx_hash().
-
name: vlan-tag
doc:
Device is capable of exposing receive packet VLAN tag via bpf_xdp_metadata_rx_vlan_tag().
doc: |
Device is capable of exposing receive packet VLAN tag via
bpf_xdp_metadata_rx_vlan_tag().
-
type: flags
name: xsk-flags
@ -425,9 +428,9 @@ attribute-sets:
-
name: rx-hw-gro-packets
doc: |
Number of packets that were coalesced from smaller packets by the device.
Counts only packets coalesced with the HW-GRO netdevice feature,
LRO-coalesced packets are not counted.
Number of packets that were coalesced from smaller packets by the
device. Counts only packets coalesced with the HW-GRO netdevice
feature, LRO-coalesced packets are not counted.
type: uint
-
name: rx-hw-gro-bytes
@ -436,8 +439,8 @@ attribute-sets:
-
name: rx-hw-gro-wire-packets
doc: |
Number of packets that were coalesced to bigger packetss with the HW-GRO
netdevice feature. LRO-coalesced packets are not counted.
Number of packets that were coalesced to bigger packetss with the
HW-GRO netdevice feature. LRO-coalesced packets are not counted.
type: uint
-
name: rx-hw-gro-wire-bytes

14
Documentation/netlink/specs/nftables.yaml
View File

@ -1205,7 +1205,9 @@ operations:
- name
-
name: destroytable
doc: Delete an existing table with destroy semantics (ignoring ENOENT errors).
doc: |
Delete an existing table with destroy semantics (ignoring ENOENT
errors).
attribute-set: table-attrs
fixed-header: nfgenmsg
do:
@ -1249,7 +1251,9 @@ operations:
- name
-
name: destroychain
doc: Delete an existing chain with destroy semantics (ignoring ENOENT errors).
doc: |
Delete an existing chain with destroy semantics (ignoring ENOENT
errors).
attribute-set: chain-attrs
fixed-header: nfgenmsg
do:
@ -1307,7 +1311,8 @@ operations:
- name
-
name: destroyrule
doc: Delete an existing rule with destroy semantics (ignoring ENOENT errors).
doc: |
Delete an existing rule with destroy semantics (ignoring ENOENT errors).
attribute-set: rule-attrs
fixed-header: nfgenmsg
do:
@ -1351,7 +1356,8 @@ operations:
- name
-
name: destroyset
doc: Delete an existing set with destroy semantics (ignoring ENOENT errors).
doc: |
Delete an existing set with destroy semantics (ignoring ENOENT errors).
attribute-set: set-attrs
fixed-header: nfgenmsg
do:

5
Documentation/netlink/specs/nl80211.yaml
View File

@ -1799,8 +1799,9 @@ operations:
-
name: get-wiphy
doc: |
Get information about a wiphy or dump a list of all wiphys. Requests to dump get-wiphy
should unconditionally include the split-wiphy-dump flag in the request.
Get information about a wiphy or dump a list of all wiphys. Requests to
dump get-wiphy should unconditionally include the split-wiphy-dump flag
in the request.
attribute-set: nl80211-attrs
do:
request:

4
Documentation/netlink/specs/ovpn.yaml
View File

@ -42,8 +42,8 @@ attribute-sets:
name: id
type: u32
doc: >-
The unique ID of the peer in the device context. To be used to identify
peers during operations for a specific device
The unique ID of the peer in the device context. To be used to
identify peers during operations for a specific device
checks:
max: 0xFFFFFF
-

14
Documentation/netlink/specs/ovs_flow.yaml
View File

@ -293,9 +293,10 @@ definitions:
enum-name: ovs-hash-alg
type: enum
doc: |
Data path hash algorithm for computing Datapath hash. The algorithm type only specifies
the fields in a flow will be used as part of the hash. Each datapath is free to use its
own hash algorithm. The hash value will be opaque to the user space daemon.
Data path hash algorithm for computing Datapath hash. The algorithm type
only specifies the fields in a flow will be used as part of the hash. Each
datapath is free to use its own hash algorithm. The hash value will be
opaque to the user space daemon.
entries:
- ovs-hash-alg-l4
@ -615,7 +616,9 @@ attribute-sets:
name: set
type: nest
nested-attributes: key-attrs
doc: Replaces the contents of an existing header. The single nested attribute specifies a header to modify and its value.
doc: |
Replaces the contents of an existing header. The single nested
attribute specifies a header to modify and its value.
-
name: push-vlan
type: binary
@ -630,7 +633,8 @@ attribute-sets:
type: nest
nested-attributes: sample-attrs
doc: |
Probabilistically executes actions, as specified in the nested attributes.
Probabilistically executes actions, as specified in the nested
attributes.
-
name: recirc
type: u32

7
Documentation/netlink/specs/tc.yaml
View File

@ -76,7 +76,8 @@ definitions:
name: overlimits
type: u32
doc: |
Number of throttle events when this flow goes out of allocated bandwidth
Number of throttle events when this flow goes out of allocated
bandwidth
-
name: bps
type: u32
@ -751,7 +752,9 @@ definitions:
-
name: count
type: u32
doc: How many drops we've done since the last time we entered dropping state
doc: |
How many drops we've done since the last time we entered dropping
state
-
name: lastcount
type: u32