[patch net-next v3] docs: netlink: add NLMSG_DONE message format for doit actions

[patch net-next v3] docs: netlink: add NLMSG_DONE message format for doit actions

[Jiri Pirko]

From: Jiri Pirko <jiri@nvidia.com>

In case NLMSG_DONE message is sent as a reply to doit action, multiple
kernel implementation do not send anything else than struct nlmsghdr.
Add this note to the Netlink intro documentation.

Signed-off-by: Jiri Pirko <jiri@nvidia.com>
---
v2->v3:
- s/avoided/absent/
v1->v2:
- Changed the note completely
---
 Documentation/userspace-api/netlink/intro.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/userspace-api/netlink/intro.rst b/Documentation/userspace-api/netlink/intro.rst
index 7b1d401210ef..aacffade8f84 100644
--- a/Documentation/userspace-api/netlink/intro.rst
+++ b/Documentation/userspace-api/netlink/intro.rst
@@ -234,6 +234,10 @@ ACK attributes may be present::
   | ** optionally extended ACK                 |
   ----------------------------------------------
 
+Note that some implementations may issue custom ``NLMSG_DONE`` messages
+in reply to ``do`` action requests. In that case the payload is
+implementation-specific and may also be absent.
+
 .. _res_fam:
 
 Resolving the Family ID
-- 
2.41.0

Re: [patch net-next v3] docs: netlink: add NLMSG_DONE message format for doit actions

[Jakub Kicinski]

On Fri,  1 Dec 2023 19:01:54 +0100 Jiri Pirko wrote:
> In case NLMSG_DONE message is sent as a reply to doit action, multiple
> kernel implementation do not send anything else than struct nlmsghdr.
> Add this note to the Netlink intro documentation.
> 
> Signed-off-by: Jiri Pirko <jiri@nvidia.com>

Reviewed-by: Jakub Kicinski <kuba@kernel.org>

Re: [patch net-next v3] docs: netlink: add NLMSG_DONE message format for doit actions

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 874 bytes --]

On Fri, Dec 01, 2023 at 07:01:54PM +0100, Jiri Pirko wrote:
> diff --git a/Documentation/userspace-api/netlink/intro.rst b/Documentation/userspace-api/netlink/intro.rst
> index 7b1d401210ef..aacffade8f84 100644
> --- a/Documentation/userspace-api/netlink/intro.rst
> +++ b/Documentation/userspace-api/netlink/intro.rst
> @@ -234,6 +234,10 @@ ACK attributes may be present::
>    | ** optionally extended ACK                 |
>    ----------------------------------------------
>  
> +Note that some implementations may issue custom ``NLMSG_DONE`` messages
> +in reply to ``do`` action requests. In that case the payload is
> +implementation-specific and may also be absent.
> +
>  .. _res_fam:
>  
>  Resolving the Family ID

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [patch net-next v3] docs: netlink: add NLMSG_DONE message format for doit actions

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Fri,  1 Dec 2023 19:01:54 +0100 you wrote:
> From: Jiri Pirko <jiri@nvidia.com>
> 
> In case NLMSG_DONE message is sent as a reply to doit action, multiple
> kernel implementation do not send anything else than struct nlmsghdr.
> Add this note to the Netlink intro documentation.
> 
> Signed-off-by: Jiri Pirko <jiri@nvidia.com>
> 
> [...]

Here is the summary with links:
  - [net-next,v3] docs: netlink: add NLMSG_DONE message format for doit actions
    https://git.kernel.org/netdev/net-next/c/8ad55b1e73c4

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html