Re: [RFC net-next 1/4] ynl: add intro docs for the concept
From: Jakub Kicinski <kuba@kernel.org>
Date: 2022-08-16 04:04:09
Also in:
linux-doc
On Mon, 15 Aug 2022 22:09:29 +0200 Johannes Berg wrote:
On Wed, 2022-08-10 at 19:23 -0700, Jakub Kicinski wrote:quoted
+Note that attribute spaces do not themselves nest, nested attributes refer to their internal +space via a ``nested-attributes`` property, so the YAML spec does not resemble the format +of the netlink messages directly.I find this a bit ... confusing. I think reading the other patch I know what you mean, but if I think of this I think more of the policy declarations than the message itself, and there we do refer to another policy? Maybe reword a bit and say Note that attribute spaces do not themselves nest, nested attributes refer to their internal space via a ``nested-attributes`` property (the name of another or the same attribute space). or something?
I think I put the cart before the horse in this looong sentence. How about: Note that the YAML spec is "flattened" and is not meant to visually resemble the format of the netlink messages (unlike certain ad-hoc documentation formats seen in kernel comments). In the YAML spec subordinate attribute sets are not defined inline as a nest, but defined in a separate attribute set referred to with a ``nested-attributes`` property of the container.