Merge pull request libgit2#6320 from libgit2/ethomson/config-docs

ethomson · web-flow · commit 70a182c6d0d6 · 2022-06-13T21:38:32.000-04:00
config: update config entry iteration lifecycle
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -449,8 +449,8 @@ GIT_EXTERN(int) git_config_multivar_iterator_new(git_config_iterator **out, cons`
`449`	`449`	`/**`
`450`	`450`	`* Return the current entry and advance the iterator`
`451`	`451`	`*`
`452`		`- * The pointers returned by this function are valid until the iterator`
`453`		`- * is freed.`
	`452`	`+ * The pointers returned by this function are valid until the next call`
	`453`	+ * to `git_config_next` or until the iterator is freed.
`454`	`454`	`*`
`455`	`455`	`* @param entry pointer to store the entry`
`456`	`456`	`* @param iter the iterator`