From: Robbie Harwood <rharwood@redhat.com>
Date: Tue, 2 Apr 2019 18:18:57 +0000 (-0400)
Subject: Clarify header comment for krb5_cc_start_seq_get()
X-Git-Tag: krb5-1.18-beta1~165
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f4f51a25dd38601357e2f64b17b51eb23f45a53e;p=thirdparty%2Fkrb5.git

Clarify header comment for krb5_cc_start_seq_get()

Previously this comment seemed to suggest that applications needed to
block all other access to the ccache (including by other processes)
during iteration.
---

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index eb31607706..75787fbdd1 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -2485,8 +2485,10 @@ krb5_cc_get_principal(krb5_context context, krb5_ccache cache,
  *
  * krb5_cc_end_seq_get() must be called to complete the retrieve operation.
  *
- * @note If @a cache is modified between the time of the call to this function
- * and the time of the final krb5_cc_end_seq_get(), the results are undefined.
+ * @note If the cache represented by @a cache is modified between the time of
+ * the call to this function and the time of the final krb5_cc_end_seq_get(),
+ * these changes may not be reflected in the results of krb5_cc_next_cred()
+ * calls.
  *
  * @retval 0  Success; otherwise - Kerberos error codes
  */