From: Ben Kaduk <kaduk@mit.edu>
Date: Sat, 23 Jul 2016 19:59:05 +0000 (-0500)
Subject: Comment why TRACE() is not used directly
X-Git-Tag: krb5-1.15-beta1~139
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=014bc344f8f6307c97b0b23326600cbc8ae1a236;p=thirdparty%2Fkrb5.git

Comment why TRACE() is not used directly

Instead, a new TRACE_* macro should be defined for each trace point, and
that macro used from the library code.
---

diff --git a/src/include/k5-trace.h b/src/include/k5-trace.h
index 045f102657..c75e264e04 100644
--- a/src/include/k5-trace.h
+++ b/src/include/k5-trace.h
@@ -28,6 +28,11 @@
  * This header contains trace macro definitions, which map trace points within
  * the code to krb5int_trace() calls with descriptive text strings.
  *
+ * A new trace macro must be defined in this file for each new location to
+ * be traced; the TRACE() macro should never be used directly.  This keeps
+ * the tracing logic centralized in one place, to facilitate integration with
+ * alternate tracing backends such as DTrace.
+ *
  * Trace logging is intended to aid power users in diagnosing configuration
  * problems by showing what's going on behind the scenes of complex operations.
  * Although trace logging is sometimes useful to developers, it is not intended