Fix: doc: action: wrong function documented for action_list destroy
authorJonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Thu, 24 Mar 2022 20:05:20 +0000 (16:05 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 25 Mar 2022 19:47:52 +0000 (15:47 -0400)
The lttng_action_list_destroy function is internal.

API users must use `lttng_action_destroy()` to destroy the returned
object of `lttng_action_list_create()`.

Change-Id: Ic910efd07dd071f7e38e48d34a5e000b3f805729
Reported-by: Michael Jeason <mjeanson@efficios.com>
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
include/lttng/action/list.h

index 9c23d60cacf4d9dc3ef5d3bba54658c52a403b9c..0dfffa296ad073e1e597c942bc9dcb252aec5430 100644 (file)
@@ -20,7 +20,7 @@ extern "C" {
  * Create a newly allocated action list object.
  *
  * Returns a new action list on success, NULL on failure. This action list
- * must be destroyed using lttng_action_list_destroy().
+ * must be destroyed using lttng_action_destroy().
  */
 LTTNG_EXPORT extern struct lttng_action *lttng_action_list_create(void);
 
This page took 0.025633 seconds and 4 git commands to generate.