Merge pull request libgit2#6500 from timrogers/timrogers/empty-docs

ethomson · web-flow · commit cfc3b3796a4f · 2023-02-23T19:41:46.000Z
Correct the definition of "empty" in the docs for `git_repository_is_empty`
diff --git a/include/git2/repository.h b/include/git2/repository.h
@@ -465,7 +465,9 @@ GIT_EXTERN(int) git_repository_head_unborn(git_repository *repo);
  * Check if a repository is empty
  *
  * An empty repository has just been initialized and contains no references
- * apart from HEAD, which must be pointing to the unborn master branch.
+ * apart from HEAD, which must be pointing to the unborn master branch,
+ * or the branch specified for the repository in the `init.defaultBranch`
+ * configuration variable.
  *
  * @param repo Repo to test
  * @return 1 if the repository is empty, 0 if it isn't, error code

Original file line number	Diff line number	Diff line change
`@@ -465,7 +465,9 @@ GIT_EXTERN(int) git_repository_head_unborn(git_repository *repo);`
`465`	`465`	`* Check if a repository is empty`
`466`	`466`	`*`
`467`	`467`	`* An empty repository has just been initialized and contains no references`
`468`		`- * apart from HEAD, which must be pointing to the unborn master branch.`
	`468`	`+ * apart from HEAD, which must be pointing to the unborn master branch,`
	`469`	+ * or the branch specified for the repository in the `init.defaultBranch`
	`470`	`+ * configuration variable.`
`469`	`471`	`*`
`470`	`472`	`* @param repo Repo to test`
`471`	`473`	`* @return 1 if the repository is empty, 0 if it isn't, error code`