Linux Kernel Selftest development
 help / color / mirror / Atom feed
From: David Gow <davidgow@google.com>
To: Brendan Higgins <brendan.higgins@linux.dev>,
	Shuah Khan <skhan@linuxfoundation.org>
Cc: Benjamin Berg <benjamin.berg@intel.com>,
	Maxime Ripard <maxime@cerno.tech>,
	linux-kselftest@vger.kernel.org, kunit-dev@googlegroups.com,
	linux-kernel@vger.kernel.org, David Gow <davidgow@google.com>,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH] kunit: Fix obsolete name in documentation headers (func->action)
Date: Tue, 30 May 2023 15:55:57 +0800	[thread overview]
Message-ID: <20230530075557.1558422-2-davidgow@google.com> (raw)

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


             reply	other threads:[~2023-05-30  7:56 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-30  7:55 David Gow [this message]
2023-05-31 12:55 ` [PATCH] kunit: Fix obsolete name in documentation headers (func->action) Maxime Ripard

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230530075557.1558422-2-davidgow@google.com \
    --to=davidgow@google.com \
    --cc=benjamin.berg@intel.com \
    --cc=brendan.higgins@linux.dev \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=maxime@cerno.tech \
    --cc=sfr@canb.auug.org.au \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox