From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Tue, 28 Aug 2018 21:23:51 +0000 (-0400)
Subject: Docs fix: probe location description is erroneous
X-Git-Tag: v2.11.0-rc1~52
X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=bff8d2177c7184a2ce763aac4b015f8ef91ce11e

Docs fix: probe location description is erroneous

A 'FUNCTION' probe location type does not trace function returns.
The current implementation only traces function entries.

Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/include/lttng/userspace-probe.h b/include/lttng/userspace-probe.h
index 9378eda8a..6b9036307 100644
--- a/include/lttng/userspace-probe.h
+++ b/include/lttng/userspace-probe.h
@@ -71,9 +71,9 @@ struct lttng_userspace_probe_location;
 
 enum lttng_userspace_probe_location_type {
 	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_UNKNOWN	= -1,
-	/* Traces a function's entry and exit. */
+	/* Function entry. */
 	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION	= 0,
-	/* Trace a single point. */
+	/* SDT probe's callsites. */
 	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT	= 1,
 };