Commit 70a182c6d0d691fd6b58706e300152af8a0ef032

Edward Thomson 2022-06-13T21:38:32

Merge pull request #6320 from libgit2/ethomson/config-docs config: update config entry iteration lifecycle

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
diff --git a/include/git2/config.h b/include/git2/config.h
index 9919447..cfab0c7 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