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

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 7e1ce5fdcd2784a0baf8c098627879149eb40d4a..a9e887e19b6e3abfaa6cd5dc1c85cd2ef6d8b235 100644 (file)
--- 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 355b14393770a8f327595051231a87d1ed2e1b3c..8f9ba04d972aa0da74d840d318bdb9d09b7b83ee 100644 (file)
--- 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;