diff options
| author | Ben Kaduk <kaduk@mit.edu> | 2012-11-19 16:36:56 -0500 |
|---|---|---|
| committer | Ben Kaduk <kaduk@mit.edu> | 2012-11-27 16:58:57 -0500 |
| commit | 6a019d5cff9aecb88591accf03ac737c6f910c69 (patch) | |
| tree | 0940cac0917ca5f0d6bbce9617814b6da308d04a /src | |
| parent | 22288fd3933830eaa76a8f9b0d1432d072a1fac3 (diff) | |
| download | krb5-6a019d5cff9aecb88591accf03ac737c6f910c69.tar.gz krb5-6a019d5cff9aecb88591accf03ac737c6f910c69.tar.xz krb5-6a019d5cff9aecb88591accf03ac737c6f910c69.zip | |
Make krb5_trace_info a typedef
Our doxygen-to-sphinx documentation bridge only processes typedefs
and not structure definitions, since we almost universally use
typedefs for our data structures. krb5_trace_info is the sole
exception, so bring it into the fold.
While here, flesh out the comment a bit more.
ticket: 7447
tags: pullup
target_version: 1.11
Diffstat (limited to 'src')
| -rw-r--r-- | src/include/krb5/krb5.hin | 16 | ||||
| -rw-r--r-- | src/lib/krb5/os/trace.c | 4 |
2 files changed, 13 insertions, 7 deletions
diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin index 7e1ce5fdc..a9e887e19 100644 --- a/src/include/krb5/krb5.hin +++ b/src/include/krb5/krb5.hin @@ -7922,14 +7922,20 @@ krb5_pac_sign(krb5_context context, krb5_pac pac, krb5_timestamp authtime, krb5_error_code KRB5_CALLCONV krb5_allow_weak_crypto(krb5_context context, krb5_boolean enable); -/* This structure may be extended to contain more fields in the future. */ -struct krb5_trace_info { +/** + * A wrapper for passing information to a @c krb5_trace_callback. + * + * Currently, it only contains the formatted message as determined + * the the format string and arguments of the tracing macro, but it + * may be extended to contain more fields in the future. + */ +typedef struct _krb5_trace_info { const char *message; -}; +} krb5_trace_info; typedef void (KRB5_CALLCONV *krb5_trace_callback)(krb5_context context, - const struct krb5_trace_info *info, + const krb5_trace_info *info, void *cb_data); /** @@ -7941,7 +7947,7 @@ typedef void * * Specify a callback for trace events occurring in krb5 operations performed * within @a context. @a fn will be invoked with @a context as the first - * argument, @a cb_data as the last argument, and a pointer to a struct + * argument, @a cb_data as the last argument, and a pointer to a * krb5_trace_info as the second argument. If the trace callback is reset via * this function or @a context is destroyed, @a fn will be invoked with a NULL * second argument so it can clean up @a cb_data. Supply a NULL value for @a diff --git a/src/lib/krb5/os/trace.c b/src/lib/krb5/os/trace.c index 355b14393..8f9ba04d9 100644 --- a/src/lib/krb5/os/trace.c +++ b/src/lib/krb5/os/trace.c @@ -342,7 +342,7 @@ void krb5int_trace(krb5_context context, const char *fmt, ...) { va_list ap; - struct krb5_trace_info info; + krb5_trace_info info; char *str = NULL, *msg = NULL; krb5_int32 sec, usec; @@ -378,7 +378,7 @@ krb5_set_trace_callback(krb5_context context, krb5_trace_callback fn, } static void KRB5_CALLCONV -file_trace_cb(krb5_context context, const struct krb5_trace_info *info, void *data) +file_trace_cb(krb5_context context, const krb5_trace_info *info, void *data) { int *fd = data; |
