diff mbox series

[net-next,v2] docs: netlink: add NLMSG_DONE message format for doit actions

Message ID 20231201153409.862397-1-jiri@resnulli.us (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series [net-next,v2] docs: netlink: add NLMSG_DONE message format for doit actions | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 8 this patch: 8
netdev/cc_maintainers warning 1 maintainers not CCed: linux-doc@vger.kernel.org
netdev/build_clang success Errors and warnings before: 8 this patch: 8
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 10 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Jiri Pirko Dec. 1, 2023, 3:34 p.m. UTC 
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>
---
v1->v2:
- Changed the note completely
---
 Documentation/userspace-api/netlink/intro.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Jakub Kicinski Dec. 1, 2023, 4:38 p.m. UTC | #1 
On Fri,  1 Dec 2023 16:34:09 +0100 Jiri Pirko wrote:
> +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 avoided.

"avoided" does not read quite right here, perhaps a native speaker
will disagree, but I'd s/avoided/absent/
Feel free to skip the 24h wait if you agree
Jiri Pirko Dec. 1, 2023, 6:01 p.m. UTC | #2 
Fri, Dec 01, 2023 at 05:38:03PM CET, kuba@kernel.org wrote:
>On Fri,  1 Dec 2023 16:34:09 +0100 Jiri Pirko wrote:
>> +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 avoided.
>
>"avoided" does not read quite right here, perhaps a native speaker
>will disagree, but I'd s/avoided/absent/
>Feel free to skip the 24h wait if you agree

Okay. Will change and send v3. Thanks!
diff mbox series

Patch

diff --git a/Documentation/userspace-api/netlink/intro.rst b/Documentation/userspace-api/netlink/intro.rst
index 7b1d401210ef..e0efa75db94b 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 avoided.
+
 .. _res_fam:
 
 Resolving the Family ID