Commit 6e5a397ca6433c4ef5a0988b2ea78108d6c6e69c

Carlos Martín Nieto 2015-01-30T18:00:26

Merge pull request #2853 from swisspol/empty_doc Clarified git_repository_is_empty() documentation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
diff --git a/include/git2/repository.h b/include/git2/repository.h
index 124aa67..2fb3813 100644
--- a/include/git2/repository.h
+++ b/include/git2/repository.h
@@ -342,8 +342,8 @@ 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.
+ * An empty repository has just been initialized and contains no references
+ * apart from HEAD, which must be pointing to the unborn master branch.
  *
  * @param repo Repo to test
  * @return 1 if the repository is empty, 0 if it isn't, error code