summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2023-02-23 19:41:46 +0000
committerGitHub <noreply@github.com>2023-02-23 19:41:46 +0000
commitcfc3b3796a4f0301e35da2869173b365c3248365 (patch)
treeccda5ee9042a3f3176e6b32e5b2669e5aa1cf027
parent6f2eedb7eb58f5af2e96cafeae7261c07c928d89 (diff)
parent86b532de1548669c8922b2bd3af57b21ab460e74 (diff)
downloadlibgit2-cfc3b3796a4f0301e35da2869173b365c3248365.tar.gz
Merge pull request #6500 from timrogers/timrogers/empty-docs
Correct the definition of "empty" in the docs for `git_repository_is_empty`
-rw-r--r--include/git2/repository.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/repository.h b/include/git2/repository.h
index 04c240d24..560e70ab6 100644
--- 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