summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2022-06-13 21:38:32 -0400
committerGitHub <noreply@github.com>2022-06-13 21:38:32 -0400
commit70a182c6d0d691fd6b58706e300152af8a0ef032 (patch)
treed44fc330ab1be95e09018f11f6e15e48e511f77a
parent96c6117414942e6d3db56e73f2354a5fd15d4962 (diff)
parent1ed1e19afad443950942b097782528544c39cd95 (diff)
downloadlibgit2-70a182c6d0d691fd6b58706e300152af8a0ef032.tar.gz
Merge pull request #6320 from libgit2/ethomson/config-docs
config: update config entry iteration lifecycle
-rw-r--r--include/git2/config.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/config.h b/include/git2/config.h
index 99194476f..cfab0c757 100644
--- a/include/git2/config.h
+++ b/include/git2/config.h
@@ -449,8 +449,8 @@ GIT_EXTERN(int) git_config_multivar_iterator_new(git_config_iterator **out, cons
/**
* Return the current entry and advance the iterator
*
- * The pointers returned by this function are valid until the iterator
- * is freed.
+ * The pointers returned by this function are valid until the next call
+ * to `git_config_next` or until the iterator is freed.
*
* @param entry pointer to store the entry
* @param iter the iterator