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 2d8c6f1257346dc22059d19441532a1ef3b8f962..9378eda8a0a149cfb9509b0b1f1256ed88f4f015 100644 (file)
--- 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,
 };