Skip to content

Commit 2b80260

Browse files
committed
CHANGELOG.md: Document new flags for git_repository_open_ext
Document GIT_REPOSITORY_OPEN_NO_DOTGIT and GIT_REPOSITORY_OPEN_FROM_ENV.
1 parent 04d6ab6 commit 2b80260

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

CHANGELOG.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,25 @@ v0.24 + 1
2020
writing into a stream. Useful when you do not know the final size or
2121
want to copy the contents from another stream.
2222

23+
* New flags for `git_repository_open_ext`:
24+
25+
* `GIT_REPOSITORY_OPEN_NO_DOTGIT` - Do not check for a repository by
26+
appending `/.git` to the `start_path`; only open the repository if
27+
`start_path` itself points to the git directory.
28+
* `GIT_REPOSITORY_OPEN_FROM_ENV` - Find and open a git repository,
29+
respecting the environment variables used by the git command-line
30+
tools. If set, `git_repository_open_ext` will ignore the other
31+
flags and the `ceiling_dirs` argument, and will allow a NULL
32+
`path` to use `GIT_DIR` or search from the current directory. The
33+
search for a repository will respect `$GIT_CEILING_DIRECTORIES`
34+
and `$GIT_DISCOVERY_ACROSS_FILESYSTEM`. The opened repository
35+
will respect `$GIT_INDEX_FILE`, `$GIT_NAMESPACE`,
36+
`$GIT_OBJECT_DIRECTORY`, and `$GIT_ALTERNATE_OBJECT_DIRECTORIES`.
37+
In the future, this flag will also cause `git_repository_open_ext`
38+
to respect `$GIT_WORK_TREE` and `$GIT_COMMON_DIR`; currently,
39+
`git_repository_open_ext` with this flag will error out if either
40+
`$GIT_WORK_TREE` or `$GIT_COMMON_DIR` is set.
41+
2342
### API removals
2443

2544
* `git_blob_create_fromchunks()` has been removed in favour of

0 commit comments

Comments
 (0)