netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jakub Kicinski <kuba@kernel.org>
To: Donald Hunter <donald.hunter@gmail.com>
Cc: netdev@vger.kernel.org, "David S. Miller" <davem@davemloft.net>,
	Eric Dumazet <edumazet@google.com>,
	Paolo Abeni <pabeni@redhat.com>, Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, Stanislav Fomichev <sdf@google.com>,
	Arkadiusz Kubalewski <arkadiusz.kubalewski@intel.com>,
	donald.hunter@redhat.com
Subject: Re: [PATCH net-next v2 02/10] doc/netlink: Document the genetlink-legacy schema extensions
Date: Tue, 15 Aug 2023 19:49:02 -0700	[thread overview]
Message-ID: <20230815194902.6ce9ae12@kernel.org> (raw)
In-Reply-To: <20230815194254.89570-3-donald.hunter@gmail.com>

On Tue, 15 Aug 2023 20:42:46 +0100 Donald Hunter wrote:
> Add description of genetlink-legacy specific attributes to the ynl spec
> documentation.
> 
> Signed-off-by: Donald Hunter <donald.hunter@gmail.com>
> ---
>  Documentation/userspace-api/netlink/specs.rst | 47 +++++++++++++++++++
>  1 file changed, 47 insertions(+)

Should we merge this with genetlink-legacy.rst?

> diff --git a/Documentation/userspace-api/netlink/specs.rst b/Documentation/userspace-api/netlink/specs.rst
> index 2e4acde890b7..dde70f9674d4 100644
> --- a/Documentation/userspace-api/netlink/specs.rst
> +++ b/Documentation/userspace-api/netlink/specs.rst
> @@ -443,3 +443,50 @@ nest
>  
>  Attribute containing other (nested) attributes.
>  ``nested-attributes`` specifies which attribute set is used inside.
> +
> +genetlink-legacy
> +================
> +
> +The genetlink-legacy schema extends the genetlink schema with some additional
> +properties that are needed to support legacy genetlink families.
> +
> +Globals
> +-------
> +
> + - ``kernel-policy`` - Specify whether the kernel input policy is ``global``,
> +   ``per-op`` or ``split``.

Maybe a few more words:

 Specify whether the kernel input policy is ``global`` i.e. the same for
 all operation of the family, defined for each operation individually 
 (``per-op``), or separately for each operation and operation type
 (do vs dump) - ``split``.

> +   ``per-op`` or ``split``.

> +Struct definitions
> +------------------
> +
> +There is a new type of definition called ``struct`` which is used for declaring
> +the C struct format of fixed headers and binary attributes.
> +
> +members
> +~~~~~~~
> +
> + - ``name`` - The attribute name of the struct member
> + - ``type`` - One of the scalar types ``u8``, ``u16``, ``u32``, ``u64``, ``s8``,
> +   ``s16``, ``s32``, ``s64``, ``string`` or ``binary``.
> + - ``byte-order`` - ``big-endian`` or ``little-endian``
> + - ``doc``, ``enum``, ``enum-as-flags``, ``display-hint`` - Same as for
> +   attribute definitions.

Hm, genetlink-legacy.rst has this:

https://docs.kernel.org/next/userspace-api/netlink/genetlink-legacy.html#structures

But the larger section is called "Other quirks (todo)"
I guess you have tackled most of the items in this section
so we shouldn't call it "todo" ?

  reply	other threads:[~2023-08-16  2:49 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-15 19:42 [PATCH net-next v2 00/10] tools/net/ynl: Add support for netlink-raw families Donald Hunter
2023-08-15 19:42 ` [PATCH net-next v2 01/10] doc/netlink: Add a schema " Donald Hunter
2023-08-16  8:41   ` Simon Horman
2023-08-16 13:19     ` Donald Hunter
2023-08-15 19:42 ` [PATCH net-next v2 02/10] doc/netlink: Document the genetlink-legacy schema extensions Donald Hunter
2023-08-16  2:49   ` Jakub Kicinski [this message]
2023-08-16  8:25     ` Donald Hunter
2023-08-16 13:16       ` Donald Hunter
2023-08-16 15:00         ` Jakub Kicinski
2023-08-15 19:42 ` [PATCH net-next v2 03/10] doc/netlink: Document the netlink-raw " Donald Hunter
2023-08-16  2:52   ` Jakub Kicinski
2023-08-16  8:32     ` Donald Hunter
2023-08-15 19:42 ` [PATCH net-next v2 04/10] tools/ynl: Add mcast-group schema parsing to ynl Donald Hunter
2023-08-16 15:12   ` Jakub Kicinski
2023-08-15 19:42 ` [PATCH net-next v2 05/10] tools/net/ynl: Refactor decode_fixed_header into NlMsg Donald Hunter
2023-08-16 15:20   ` Jakub Kicinski
2023-08-17 15:14     ` Donald Hunter
2023-08-18  1:37       ` Jakub Kicinski
2023-08-18 10:21         ` Donald Hunter
2023-08-15 19:42 ` [PATCH net-next v2 06/10] tools/net/ynl: Add support for netlink-raw families Donald Hunter
2023-08-16 15:29   ` Jakub Kicinski
2023-08-17  9:10     ` Donald Hunter
2023-08-18  1:18       ` Jakub Kicinski
2023-08-21 14:00         ` Donald Hunter
2023-08-15 19:42 ` [PATCH net-next v2 07/10] tools/net/ynl: Implement nlattr array-nest decoding in ynl Donald Hunter
2023-08-16 15:31   ` Jakub Kicinski
2023-08-15 19:42 ` [PATCH net-next v2 08/10] doc/netlink: Add spec for rt addr messages Donald Hunter
2023-08-15 19:42 ` [PATCH net-next v2 09/10] doc/netlink: Add spec for rt link messages Donald Hunter
2023-08-15 19:42 ` [PATCH net-next v2 10/10] doc/netlink: Add spec for rt route messages Donald Hunter

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230815194902.6ce9ae12@kernel.org \
    --to=kuba@kernel.org \
    --cc=arkadiusz.kubalewski@intel.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=donald.hunter@gmail.com \
    --cc=donald.hunter@redhat.com \
    --cc=edumazet@google.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=netdev@vger.kernel.org \
    --cc=pabeni@redhat.com \
    --cc=sdf@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).