Skip to contentSkip to conversation

lib: Fix some kernel-doc comments

PATCH Applied Yang Li 2 participants 2 messages Nov 7, 2022 – Nov 8, 2022

Subsystems (3)
lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 lib: Fix some kernel-doc comments

Make the description of @policy to @p in nla_policy_len() to clear the below warnings:

lib/nlattr.c:660: warning: Function parameter or member 'p' not described in 'nla_policy_len' lib/nlattr.c:660: warning: Excess function parameter 'policy' description in 'nla_policy_len'

---
 lib/nlattr.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
lib/nlattr.c +1 -1
index b67a53e29b8f..9055e8b4d144 100644
@@ -646,7 +646,7 @@ EXPORT_SYMBOL(__nla_validate);
 
 /**
  * nla_policy_len - Determine the max. length of a policy
- * @policy: policy to use
+ * @p: policy to use
  * @n: number of policies
  *
  * Determines the max. length of the policy.  It is currently used
Signature · 1 line
2.20.1.7.g153144c
#1 lore raw
This patch was applied to netdev/net-next.git (master) by Jakub Kicinski <[email protected]>:

Hello:

This patch was applied to netdev/net-next.git (master) by Jakub Kicinski <[email protected]>:

Quoted 11 lines · On Mon, 7 Nov 2022 14:26:23 +0800 you wrote:

Make the description of @policy to @p in nla_policy_len() to clear the below warnings:

lib/nlattr.c:660: warning: Function parameter or member 'p' not described in 'nla_policy_len' lib/nlattr.c:660: warning: Excess function parameter 'policy' description in 'nla_policy_len'

[...]

Here is the summary with links:
- [-next] lib: Fix some kernel-doc comments

    https://git.kernel.org/netdev/net-next/c/8e18be7610ae

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html