diff options
| author | Ben Kaduk <kaduk@mit.edu> | 2016-07-23 14:59:05 -0500 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2016-07-25 14:46:33 -0500 |
| commit | 014bc344f8f6307c97b0b23326600cbc8ae1a236 (patch) | |
| tree | a80fe43f2490b876d1a0a5d4ff7a57bbada91896 /src/include/k5-trace.h | |
| parent | 6f47cd69a9fd1fe1ef8aadb4bae30612382304b1 (diff) | |
| download | krb5-014bc344f8f6307c97b0b23326600cbc8ae1a236.zip krb5-014bc344f8f6307c97b0b23326600cbc8ae1a236.tar.gz krb5-014bc344f8f6307c97b0b23326600cbc8ae1a236.tar.bz2 | |
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.
Diffstat (limited to 'src/include/k5-trace.h')
| -rw-r--r-- | src/include/k5-trace.h | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/include/k5-trace.h b/src/include/k5-trace.h index 045f102..c75e264 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 |