summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2016-06-30 08:08:36 -0700
committerJosh Triplett <josh@joshtriplett.org>2016-06-30 08:08:36 -0700
commit2b80260ea580a454495cb0cb87c9f1b38a5cc10b (patch)
tree1e41a605daaa498dc4a263e8f140ab46425a7cc9
parent04d6ab6c4c86106b02d78f6f0580a42b91c3eed9 (diff)
downloadlibgit2-2b80260ea580a454495cb0cb87c9f1b38a5cc10b.tar.gz
CHANGELOG.md: Document new flags for git_repository_open_ext
Document GIT_REPOSITORY_OPEN_NO_DOTGIT and GIT_REPOSITORY_OPEN_FROM_ENV.
-rw-r--r--CHANGELOG.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7f3aa884c..44d868e7e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -20,6 +20,25 @@ v0.24 + 1
writing into a stream. Useful when you do not know the final size or
want to copy the contents from another stream.
+* New flags for `git_repository_open_ext`:
+
+ * `GIT_REPOSITORY_OPEN_NO_DOTGIT` - Do not check for a repository by
+ appending `/.git` to the `start_path`; only open the repository if
+ `start_path` itself points to the git directory.
+ * `GIT_REPOSITORY_OPEN_FROM_ENV` - Find and open a git repository,
+ respecting the environment variables used by the git command-line
+ tools. If set, `git_repository_open_ext` will ignore the other
+ flags and the `ceiling_dirs` argument, and will allow a NULL
+ `path` to use `GIT_DIR` or search from the current directory. The
+ search for a repository will respect `$GIT_CEILING_DIRECTORIES`
+ and `$GIT_DISCOVERY_ACROSS_FILESYSTEM`. The opened repository
+ will respect `$GIT_INDEX_FILE`, `$GIT_NAMESPACE`,
+ `$GIT_OBJECT_DIRECTORY`, and `$GIT_ALTERNATE_OBJECT_DIRECTORIES`.
+ In the future, this flag will also cause `git_repository_open_ext`
+ to respect `$GIT_WORK_TREE` and `$GIT_COMMON_DIR`; currently,
+ `git_repository_open_ext` with this flag will error out if either
+ `$GIT_WORK_TREE` or `$GIT_COMMON_DIR` is set.
+
### API removals
* `git_blob_create_fromchunks()` has been removed in favour of