Re: [PATCH net-next] Doc: netlink: support unterminated-ok

From: Jakub Kicinski
Date: Thu Mar 07 2024 - 23:35:34 EST


On Thu, 7 Mar 2024 15:01:06 +0800 Hangbin Liu wrote:
> Subject: [PATCH net-next] Doc: netlink: support unterminated-ok

I'd use this subject:

netlink: specs: support unterminated-ok

> ynl-gen-c.py supports check unterminated-ok, but the yaml schemas don't
> have this key. Add this to the yaml files.

> diff --git a/Documentation/netlink/genetlink-c.yaml b/Documentation/netlink/genetlink-c.yaml
> index c58f7153fcf8..7094d619cbb6 100644
> --- a/Documentation/netlink/genetlink-c.yaml
> +++ b/Documentation/netlink/genetlink-c.yaml
> @@ -208,6 +208,9 @@ properties:
> exact-len:
> description: Exact length for a string or a binary attribute.
> $ref: '#/$defs/len-or-define'
> + unterminated-ok:
> + description: Allow the string to not use terminator.
> + type: boolean

Can we expand the doc a little? How about:

description: |
For string attributes, do not check whether attribute
contains the terminating null character.

Also maybe let's leave this out of the spec for:

Documentation/netlink/genetlink.yaml

that spec is supposed to be simplified, supporting both string flavors
just complicates things.