summaryrefslogtreecommitdiffstats
path: root/Documentation/netlink/genetlink.yaml
diff options
context:
space:
mode:
authorDonald Hunter <donald.hunter@gmail.com>2023-06-23 21:19:26 +0100
committerJakub Kicinski <kuba@kernel.org>2023-06-24 15:45:49 -0700
commit737eab775d367b0ba6575d8aa2073c607a9bcf9e (patch)
tree5e700a1a32ede4d9cf119929d2634e1007145e96 /Documentation/netlink/genetlink.yaml
parent2ffecf1a42ccd67e4b2fec7a613e375014869d60 (diff)
downloadlinux-737eab775d367b0ba6575d8aa2073c607a9bcf9e.tar.gz
linux-737eab775d367b0ba6575d8aa2073c607a9bcf9e.tar.bz2
linux-737eab775d367b0ba6575d8aa2073c607a9bcf9e.zip
netlink: specs: add display-hint to schema definitions
Add a display-hint property to the netlink schema that is for providing optional hints to generic netlink clients about how to display attribute values. A display-hint on an attribute definition is intended for letting a client such as ynl know that, for example, a u32 should be rendered as an ipv4 address. The display-hint enumeration includes a small number of networking domain-specific value types. Signed-off-by: Donald Hunter <donald.hunter@gmail.com> Link: https://lore.kernel.org/r/20230623201928.14275-2-donald.hunter@gmail.com Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Diffstat (limited to 'Documentation/netlink/genetlink.yaml')
-rw-r--r--Documentation/netlink/genetlink.yaml6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/netlink/genetlink.yaml b/Documentation/netlink/genetlink.yaml
index d8b2cdeba058..1cbb448d2f1c 100644
--- a/Documentation/netlink/genetlink.yaml
+++ b/Documentation/netlink/genetlink.yaml
@@ -168,6 +168,12 @@ properties:
description: Max length for a string or a binary attribute.
$ref: '#/$defs/len-or-define'
sub-type: *attr-type
+ display-hint: &display-hint
+ description: |
+ Optional format indicator that is intended only for choosing
+ the right formatting mechanism when displaying values of this
+ type.
+ enum: [ hex, mac, fddi, ipv4, ipv6, uuid ]
# Make sure name-prefix does not appear in subsets (subsets inherit naming)
dependencies: