Commit c042030a authored by David Gow's avatar David Gow Committed by Shuah Khan
Browse files

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



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: b9dce8a1 ("kunit: Add kunit_add_action() to defer a call until test exit")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/lkml/20230530151840.16a56460@canb.auug.org.au/


Signed-off-by: default avatarDavid Gow <davidgow@google.com>
Reviewed-by: default avatarMaxime Ripard <mripard@kernel.org>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent 6543960c

include/kunit/resource.h

+4 −4
Original line number Diff line number Diff line
@@ -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