[PATCH net-next] flow_offload: fix flow_offload_has_one_action() kdoc

[PATCH net-next] flow_offload: fix flow_offload_has_one_action() kdoc

[Asbjørn Sloth Tønnesen]

include/net/flow_offload.h:351: warning:
  No description found for return value of 'flow_offload_has_one_action'

Fixes: ab79af32b0a5 ("mlxsw: use intermediate representation for matchall offload")
Signed-off-by: Asbjørn Sloth Tønnesen <ast@fiberby.net>
---
 include/net/flow_offload.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/net/flow_offload.h b/include/net/flow_offload.h
index 314087a5e1818..7726b4a97050e 100644
--- a/include/net/flow_offload.h
+++ b/include/net/flow_offload.h
@@ -345,7 +345,7 @@ static inline bool flow_action_has_entries(const struct flow_action *action)
  * flow_offload_has_one_action() - check if exactly one action is present
  * @action: tc filter flow offload action
  *
- * Returns true if exactly one action is present.
+ * Return: true if exactly one action is present.
  */
 static inline bool flow_offload_has_one_action(const struct flow_action *action)
 {
-- 
2.43.0

Re: [PATCH net-next] flow_offload: fix flow_offload_has_one_action() kdoc

[Pieter Jansen van Vuuren]

[Removed my old email address from CC]

This LGTM, thank you.

Reviewed-by: Pieter Jansen van Vuuren <pieter.jansen-van-vuuren@amd.com>

On 10/04/2024 12:47, Asbjørn Sloth Tønnesen wrote:
> include/net/flow_offload.h:351: warning:
>   No description found for return value of 'flow_offload_has_one_action'
> 
> Fixes: ab79af32b0a5 ("mlxsw: use intermediate representation for matchall offload")
> Signed-off-by: Asbjørn Sloth Tønnesen <ast@fiberby.net>
> ---
>  include/net/flow_offload.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/net/flow_offload.h b/include/net/flow_offload.h
> index 314087a5e1818..7726b4a97050e 100644
> --- a/include/net/flow_offload.h
> +++ b/include/net/flow_offload.h
> @@ -345,7 +345,7 @@ static inline bool flow_action_has_entries(const struct flow_action *action)
>   * flow_offload_has_one_action() - check if exactly one action is present
>   * @action: tc filter flow offload action
>   *
> - * Returns true if exactly one action is present.
> + * Return: true if exactly one action is present.
>   */
>  static inline bool flow_offload_has_one_action(const struct flow_action *action)
>  {

Re: [PATCH net-next] flow_offload: fix flow_offload_has_one_action() kdoc

[Jakub Kicinski]

On Thu, 11 Apr 2024 12:32:44 +0100 Pieter Jansen van Vuuren wrote:
> [Removed my old email address from CC]
> 
> This LGTM, thank you.
> 
> Reviewed-by: Pieter Jansen van Vuuren <pieter.jansen-van-vuuren@amd.com>

Thanks Pieter! :)

Consider adding a .mailmap entry to remap the email addr.
We already have Simon, Quentin and myself there, from @netronome :)

Re: [PATCH net-next] flow_offload: fix flow_offload_has_one_action() kdoc

[patchwork-bot+netdevbpf]

Hello:

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

On Wed, 10 Apr 2024 11:47:17 +0000 you wrote:
> include/net/flow_offload.h:351: warning:
>   No description found for return value of 'flow_offload_has_one_action'
> 
> Fixes: ab79af32b0a5 ("mlxsw: use intermediate representation for matchall offload")
> Signed-off-by: Asbjørn Sloth Tønnesen <ast@fiberby.net>
> ---
>  include/net/flow_offload.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Here is the summary with links:
  - [net-next] flow_offload: fix flow_offload_has_one_action() kdoc
    https://git.kernel.org/netdev/net-next/c/e1eb10f8ef10

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

Re: [PATCH net-next] flow_offload: fix flow_offload_has_one_action() kdoc

[Pieter Jansen van Vuuren]

On 12/04/2024 03:35, Jakub Kicinski wrote:
> On Thu, 11 Apr 2024 12:32:44 +0100 Pieter Jansen van Vuuren wrote:
>> [Removed my old email address from CC]
>>
>> This LGTM, thank you.
>>
>> Reviewed-by: Pieter Jansen van Vuuren <pieter.jansen-van-vuuren@amd.com>
> 
> Thanks Pieter! :)
> 
> Consider adding a .mailmap entry to remap the email addr.
> We already have Simon, Quentin and myself there, from @netronome :)
> 

Thank you Kuba, will do.