From: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Date: Mon, 27 Aug 2018 21:57:31 +0000 (-0400)
Subject: Docs: distinction  between function and tracepoint probe locations
X-Git-Tag: v2.11.0-rc1~57
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=a94797228bb9f0752e012d67d45f49af0c76d9c3;p=lttng-tools.git

Docs: distinction  between function and tracepoint probe locations

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 2d8c6f125..9378eda8a 100644
--- a/include/lttng/userspace-probe.h
+++ b/include/lttng/userspace-probe.h
@@ -71,7 +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. */
 	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_FUNCTION	= 0,
+	/* Trace a single point. */
 	LTTNG_USERSPACE_PROBE_LOCATION_TYPE_TRACEPOINT	= 1,
 };