From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Tue, 20 Nov 2012 16:38:21 +0000 (-0500)
Subject: document that tracepoint names should ideally not be re-used
X-Git-Tag: v2.1.0-rc2~13
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=d646ca64871144940cdca6ad9db71aad13873495;p=lttng-ust.git

document that tracepoint names should ideally not be re-used

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/doc/man/lttng-ust.3 b/doc/man/lttng-ust.3
index 818ef103..08927c64 100644
--- a/doc/man/lttng-ust.3
+++ b/doc/man/lttng-ust.3
@@ -238,6 +238,10 @@ For instance, add within a function:
 As a call to the tracepoint. It will only be activated when requested by
 lttng(1) through lttng-sessiond(8).
 
+Even though LTTng-UST supports tracepoint() call site duplicates having
+the same provider and event name, it is recommended to use a
+provider event name pair only once within the source code to help
+mapping events back to their call sites when analyzing the trace.
 .fi
 
 .SH "BUILDING/LINKING THE TRACEPOINT PROVIDER"