From: Ben Kaduk <kaduk@mit.edu>
Date: Wed, 11 Jun 2014 20:38:57 +0000 (-0400)
Subject: Document krb5_kt_next_entry() requirement
X-Git-Tag: krb5-1.15-beta1~23
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e70c73b804400a2f18a044dd386dbf1a8430b92e;p=thirdparty%2Fkrb5.git

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.

ticket: 8500 (new)
target_version: 1.14-next
tags: pullup
---

diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin
index c8928cbf71..44c8bfa956 100644
--- a/src/include/krb5/krb5.hin
+++ b/src/include/krb5/krb5.hin
@@ -2903,6 +2903,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()
  *