Skip to contentSkip to conversation

Documentation: kunit: Fix KUNIT_DEFINE_ACTION_WRAPPER() argument order

PATCH New Kees Cook 1 participant 1 message Sep 21

Subsystems (4)
lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 Documentation: kunit: Fix KUNIT_DEFINE_ACTION_WRAPPER() argument order

The macro is

#define KUNIT_DEFINE_ACTION_WRAPPER(wrapper, orig, arg_type) ...

so it defines "wrapper" which calls orig(arg_type). The example names them the other way round. Swap the two order.

Fixes 56778b49c9a2c ("kunit: Add a macro to wrap a deferred action function")
Assisted-by LLM

---
Cc: Brendan Higgins <[email protected]>
Cc: David Gow <[email protected]>
Cc: Rae Moar <[email protected]>
Cc: Jonathan Corbet <[email protected]>
Cc: Shuah Khan <[email protected]>
Cc: <[email protected]>
Cc: <[email protected]>

---
 Documentation/dev-tools/kunit/usage.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/dev-tools/kunit/usage.rst +1 -1
index 1c78dfff94e8..8fec131f8ee7 100644
@@ -1028,7 +1028,7 @@ with the ``KUNIT_DEFINE_ACTION_WRAPPER()`` macro, for example:
 
 .. code-block:: C
 
-	KUNIT_DEFINE_ACTION_WRAPPER(device_unregister, device_unregister_wrapper, struct device *);
+	KUNIT_DEFINE_ACTION_WRAPPER(device_unregister_wrapper, device_unregister, struct device *);
 	kunit_add_action(test, &device_unregister_wrapper, &dev);
 
 You should do this in preference to manually casting to the ``kunit_action_t`` type,
Signature · 1 line
2.34.1