Skip to content

Commit

Permalink
Comment why TRACE() is not used directly
Browse files Browse the repository at this point in the history
Instead, a new TRACE_* macro should be defined for each trace point, and
that macro used from the library code.
  • Loading branch information
kaduk committed Jul 25, 2016
1 parent 6f47cd6 commit 014bc34
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/include/k5-trace.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 014bc34

Please sign in to comment.