diff options
| author | Michael Catanzaro <mcatanzaro@igalia.com> | 2018-02-09 10:22:24 -0600 |
|---|---|---|
| committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2018-02-10 13:13:05 +0100 |
| commit | 48db5be4957df94551fda2fab96847742e500dc7 (patch) | |
| tree | ccf5676e32232ab89c23ba8dcdecbcc79adf1b43 | |
| parent | a2585735558ed0aee65ad33c56dc88054e718031 (diff) | |
| download | gnutls-48db5be4957df94551fda2fab96847742e500dc7.tar.gz | |
Improve documentation of gnutls_x509_trust_list_iter_get_ca [ci skip]
The documentation is confusing because it implies that
gnutls_x509_trust_list_iter_deinit() should be called after using this
function, but in fact it is generally not necessary.
Also, there was a typo here ("usin").
Signed-off-by: Michael Catanzaro <mcatanzaro@igalia.com>
| -rw-r--r-- | lib/x509/verify-high.c | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/x509/verify-high.c b/lib/x509/verify-high.c index 7b375d61fb..18906ddc1a 100644 --- a/lib/x509/verify-high.c +++ b/lib/x509/verify-high.c @@ -397,8 +397,11 @@ advance_iter(gnutls_x509_trust_list_t list, * When past the last element is accessed %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE * is returned and the iterator is reset. * - * After use, the iterator must be deinitialized usin - * gnutls_x509_trust_list_iter_deinit(). + * The iterator is deinitialized and reset to %NULL automatically by this + * function after iterating through all elements until + * %GNUTLS_E_REQUESTED_DATA_NOT_AVAILABLE is returned. If the iteration is + * aborted early, it must be manually deinitialized using + * gnutls_x509_trust_list_iter_deinit(). * * Returns: On success, %GNUTLS_E_SUCCESS (0) is returned, otherwise a * negative error value. |