diff mbox series

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

Message ID 20240410114718.15145-1-ast@fiberby.net (mailing list archive)
State Accepted
Commit e1eb10f8ef1068e565b24daa3e95bd8bc95d8cdc
Delegated to: Netdev Maintainers
Headers show
Series [net-next] flow_offload: fix flow_offload_has_one_action() kdoc | 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; no diff in generated;
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: 2765 this patch: 2765
netdev/build_tools success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers fail 1 blamed authors not CCed: jiri@resnulli.us; 1 maintainers not CCed: jiri@resnulli.us
netdev/build_clang success Errors and warnings before: 989 this patch: 989
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 Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 2974 this patch: 2974
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 8 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 1 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-04-11--00-00 (tests: 959)

Commit Message

Asbjørn Sloth Tønnesen April 10, 2024, 11:47 a.m. UTC
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(-)

Comments

Pieter Jansen van Vuuren April 11, 2024, 11:32 a.m. UTC | #1
[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)
>  {
Jakub Kicinski April 12, 2024, 2:35 a.m. UTC | #2
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 :)
patchwork-bot+netdevbpf@kernel.org April 12, 2024, 2:50 a.m. UTC | #3
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!
Pieter Jansen van Vuuren April 12, 2024, 1:40 p.m. UTC | #4
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.
diff mbox series

Patch

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)
 {