From: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Date: Thu, 24 Mar 2022 20:05:20 +0000 (-0400)
Subject: Fix: doc: action: wrong function documented for action_list destroy
X-Git-Tag: v2.13.5~1
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=7dc7ba119d1e04031494fa3aabd1c3a31b885ecf;p=lttng-tools.git

Fix: doc: action: wrong function documented for action_list destroy

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>
---

diff --git a/include/lttng/action/list.h b/include/lttng/action/list.h
index f7331f083..24c37dcb0 100644
--- a/include/lttng/action/list.h
+++ b/include/lttng/action/list.h
@@ -19,7 +19,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().
  */
 extern struct lttng_action *lttng_action_list_create(void);