[PATCH] kunit: Fix obsolete name in documentation headers (func->action)

[PATCH] kunit: Fix obsolete name in documentation headers (func->action)

[David Gow]

The kunit_add_action() and related functions named the kunit_action_t
parameter 'func' in early drafts, which was later renamed to 'action'
However, the doc comments were not properly updated.

Fix these to avoid confusion and 'make htmldocs' warnings.

Fixes: b9dce8a1ed3e ("kunit: Add kunit_add_action() to defer a call until test exit")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/lkml/20230530151840.16a56460@canb.auug.org.au/
Signed-off-by: David Gow <davidgow@google.com>
---
 include/kunit/resource.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/kunit/resource.h b/include/kunit/resource.h
index b64eb783b1bc..c7383e90f5c9 100644
--- a/include/kunit/resource.h
+++ b/include/kunit/resource.h
@@ -393,7 +393,7 @@ typedef void (kunit_action_t)(void *);
 /**
  * kunit_add_action() - Call a function when the test ends.
  * @test: Test case to associate the action with.
- * @func: The function to run on test exit
+ * @action: The function to run on test exit
  * @ctx: Data passed into @func
  *
  * Defer the execution of a function until the test exits, either normally or
@@ -415,7 +415,7 @@ int kunit_add_action(struct kunit *test, kunit_action_t *action, void *ctx);
 /**
  * kunit_add_action_or_reset() - Call a function when the test ends.
  * @test: Test case to associate the action with.
- * @func: The function to run on test exit
+ * @action: The function to run on test exit
  * @ctx: Data passed into @func
  *
  * Defer the execution of a function until the test exits, either normally or
@@ -441,7 +441,7 @@ int kunit_add_action_or_reset(struct kunit *test, kunit_action_t *action,
 /**
  * kunit_remove_action() - Cancel a matching deferred action.
  * @test: Test case the action is associated with.
- * @func: The deferred function to cancel.
+ * @action: The deferred function to cancel.
  * @ctx: The context passed to the deferred function to trigger.
  *
  * Prevent an action deferred via kunit_add_action() from executing when the
@@ -459,7 +459,7 @@ void kunit_remove_action(struct kunit *test,
 /**
  * kunit_release_action() - Run a matching action call immediately.
  * @test: Test case the action is associated with.
- * @func: The deferred function to trigger.
+ * @action: The deferred function to trigger.
  * @ctx: The context passed to the deferred function to trigger.
  *
  * Execute a function deferred via kunit_add_action()) immediately, rather than
-- 
2.41.0.rc0.172.g3f132b7071-goog

Re: [PATCH] kunit: Fix obsolete name in documentation headers (func->action)

[Maxime Ripard]

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

On Tue, May 30, 2023 at 03:55:57PM +0800, David Gow wrote:
> The kunit_add_action() and related functions named the kunit_action_t
> parameter 'func' in early drafts, which was later renamed to 'action'
> However, the doc comments were not properly updated.
> 
> Fix these to avoid confusion and 'make htmldocs' warnings.
> 
> Fixes: b9dce8a1ed3e ("kunit: Add kunit_add_action() to defer a call until test exit")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/lkml/20230530151840.16a56460@canb.auug.org.au/
> Signed-off-by: David Gow <davidgow@google.com>

Reviewed-by: Maxime Ripard <mripard@kernel.org>

Maxime

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