Document krb5_kt_next_entry() requirement

Successful calls to krb5_kt_next_entry() return a krb5_keytab_entry
that the caller is responsible for freeing.  Note this, and the
proper function to do so, in the doxygen comments.

(cherry picked from commit e70c73b804400a2f18a044dd386dbf1a8430b92e)

ticket: 8500
version_fixed: 1.14.5

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index e2c08ae1525a567a2cadab2d28c34f663c806753..bac076aa0a979b06d89ee53f081f192d33295a9e 100644 (file)
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -2899,6 +2899,7 @@ krb5_kt_start_seq_get(krb5_context context, krb5_keytab keytab,
  * @param [in]  cursor          Key table cursor
  *
  * Return the next sequential entry in @a keytab and advance @a cursor.
+ * Callers must release the returned entry with krb5_kt_free_entry().
  *
  * @sa krb5_kt_start_seq_get(), krb5_kt_end_seq_get()
  *