Files
linux-stable-mirror/Documentation/netlink/specs/rt-addr.yaml
T
Matthieu Baerts (NGI0) 12e74931ee netlink: specs: explicitly declare block scalar strings
In YAML, it is allowed to declare a scalar strings at the next lines
without explicitly declaring them as a block. Yet, they looks weird, and
can cause issues when ':' or '#' are present.

The modified lines didn't have issues with the special characters, but
it seems better to explicitly declare such blocks as scalar strings to
encourage people to "properly" declare future scalar strings.

The right angle bracket is used with a minus sign to indicate that the
folded style should be used without adding extra newlines. By doing
that, the output is not changed compared to what was done before this
patch.

Suggested-by: Donald Hunter <donald.hunter@gmail.com>
Signed-off-by: Matthieu Baerts (NGI0) <matttbe@kernel.org>
Link: https://patch.msgid.link/20250913-net-next-ynl-attr-doc-rst-v3-3-4f06420d87db@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
2025-09-15 18:27:19 -07:00

195 lines
3.4 KiB
YAML

# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
---
name: rt-addr
protocol: netlink-raw
uapi-header: linux/rtnetlink.h
protonum: 0
doc: >-
Address configuration over rtnetlink.
definitions:
-
name: ifaddrmsg
type: struct
members:
-
name: ifa-family
type: u8
-
name: ifa-prefixlen
type: u8
-
name: ifa-flags
type: u8
enum: ifa-flags
enum-as-flags: true
-
name: ifa-scope
type: u8
-
name: ifa-index
type: u32
-
name: ifa-cacheinfo
type: struct
members:
-
name: ifa-prefered
type: u32
-
name: ifa-valid
type: u32
-
name: cstamp
type: u32
-
name: tstamp
type: u32
-
name: ifa-flags
type: flags
name-prefix: ifa-f-
enum-name:
entries:
-
name: secondary
-
name: nodad
-
name: optimistic
-
name: dadfailed
-
name: homeaddress
-
name: deprecated
-
name: tentative
-
name: permanent
-
name: managetempaddr
-
name: noprefixroute
-
name: mcautojoin
-
name: stable-privacy
attribute-sets:
-
name: addr-attrs
name-prefix: ifa-
attributes:
-
name: address
type: binary
display-hint: ipv4
-
name: local
type: binary
display-hint: ipv4
-
name: label
type: string
-
name: broadcast
type: binary
display-hint: ipv4
-
name: anycast
type: binary
-
name: cacheinfo
type: binary
struct: ifa-cacheinfo
-
name: multicast
type: binary
-
name: flags
type: u32
enum: ifa-flags
enum-as-flags: true
-
name: rt-priority
type: u32
-
name: target-netnsid
type: binary
-
name: proto
type: u8
operations:
fixed-header: ifaddrmsg
enum-model: directional
name-prefix: rtm-
list:
-
name: newaddr
doc: Add new address
attribute-set: addr-attrs
do:
request:
value: 20
attributes: &ifaddr-all
- address
- label
- local
- cacheinfo
-
name: deladdr
doc: Remove address
attribute-set: addr-attrs
do:
request:
value: 21
attributes:
- address
- local
-
name: getaddr
doc: Dump address information.
attribute-set: addr-attrs
dump:
request:
value: 22
attributes: []
reply:
value: 20
attributes: *ifaddr-all
-
name: getmulticast
doc: Get / dump IPv4/IPv6 multicast addresses.
attribute-set: addr-attrs
fixed-header: ifaddrmsg
do:
request:
value: 58
attributes: []
reply:
value: 58
attributes: &mcaddr-attrs
- multicast
- cacheinfo
dump:
request:
value: 58
attributes: []
reply:
value: 58
attributes: *mcaddr-attrs
mcast-groups:
list:
-
name: rtnlgrp-ipv4-ifaddr
value: 5
-
name: rtnlgrp-ipv6-ifaddr
value: 9