[PATCH net-next v2 03/10] doc/netlink: Document the netlink-raw schema extensions
From: Donald Hunter <donald.hunter@gmail.com>
Date: 2023-08-15 19:44:26
Also in:
linux-doc
Subsystem:
documentation, networking [general], the rest, yaml netlink (ynl) · Maintainers:
Jonathan Corbet, "David S. Miller", Eric Dumazet, Jakub Kicinski, Paolo Abeni, Linus Torvalds, Donald Hunter
Add description of netlink-raw specific attributes to the ynl spec documentation and refer to the classic netlink documentation. Signed-off-by: Donald Hunter <donald.hunter@gmail.com> --- Documentation/userspace-api/netlink/intro.rst | 2 ++ Documentation/userspace-api/netlink/specs.rst | 17 +++++++++++++++++ 2 files changed, 19 insertions(+)
diff --git a/Documentation/userspace-api/netlink/intro.rst b/Documentation/userspace-api/netlink/intro.rst
index 0955e9f203d3..3ea70ad53c58 100644
--- a/Documentation/userspace-api/netlink/intro.rst
+++ b/Documentation/userspace-api/netlink/intro.rst@@ -528,6 +528,8 @@ families may, however, require a larger buffer. 32kB buffer is recommended for most efficient handling of dumps (larger buffer fits more dumped objects and therefore fewer recvmsg() calls are needed). +.. _classic_netlink: + Classic Netlink ===============
diff --git a/Documentation/userspace-api/netlink/specs.rst b/Documentation/userspace-api/netlink/specs.rst
index dde70f9674d4..98978a014488 100644
--- a/Documentation/userspace-api/netlink/specs.rst
+++ b/Documentation/userspace-api/netlink/specs.rst@@ -490,3 +490,20 @@ struct data. - ``fixed-header`` - name of the struct definition to be used for the fixed header data. This can be specified as a default for all operations and on a per-operation basis. + +netlink-raw +=========== + +The netlink-raw schema extends the genetlink-legacy schema with properties that +are needed to specify the protocol numbers and multicast IDs used by raw netlink +families. See :ref:`classic_netlink` for more information. + +Globals +------- + + - ``protonum`` - Protocol number to use when opening a netlink socket. + +Multicast group properties +-------------------------- + + - ``value`` - ID to use for multicast group registration.
--
2.41.0