Added the note to the trace API functions that they have higher priority than the KRB5_TRACE env variable

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25466 dc483132-0cff-0310-8789-dd5450dbe970

1 files changed, 8 insertions, 2 deletions

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index 5f667cee21..f3d0225a0d 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -2770,7 +2770,7 @@ krb5_kt_get_type(krb5_context context, krb5_keytab keytab);
  * @param [out] name            Key table name
  * @param [in]  namelen         Maximum length to fill in name
  *
- * Fills in @a with the name of @a keytab including the type and delimiter.
+ * Fills in @a name with the name of @a keytab including the type and delimiter.
  *
  * @sa MAX_KEYTAB_NAME_LEN
  *
@@ -4301,7 +4301,7 @@ krb5_cc_dup(krb5_context context, krb5_ccache in, krb5_ccache *out);
  *
  * @param [in] context          Library context
  *
- * Try the environment variable KRB5CCNAME first then, if it is not set,
+ * Try the environment variable @a KRB5CCNAME first then, if it is not set,
  * fall back on the default ccache name for the OS.
  *
  * @return
@@ -7590,6 +7590,9 @@ typedef void
  * second argument so it can clean up @a cb_data.  Supply a NULL value for @a
  * fn to disable trace callbacks within @a context.
  *
+ * @note This function overrides the information passed through the
+ * @a KRB5_TRACE environment variable.
+ *
  * @return Returns KRB5_TRACE_NOSUPP if tracing is not supported in the library
  * (unless @a fn is NULL).
  */
@@ -7606,6 +7609,9 @@ krb5_set_trace_callback(krb5_context context, krb5_trace_callback fn,
  * Open @a filename for appending (creating it, if necessary) and set up a
  * callback to write trace events to it.
  *
+ * @note This function overrides the information passed through the
+ * @a KRB5_TRACE environment variable.
+ *
  * @retval KRB5_TRACE_NOSUPP Tracing is not supported in the library.
  */
 krb5_error_code KRB5_CALLCONV