diff options
| author | Edward Thomson <ethomson@github.com> | 2021-09-27 08:39:39 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-27 08:39:39 -0400 |
| commit | 853ba203208fcb4e7c3765f53a4d17a3db77f160 (patch) | |
| tree | 20c1b9a712e79a3e56ae86ab6eda2b0645c0ca03 /include/git2 | |
| parent | a6f6a9f4576b4d9bdcf9f9b1d6389a3f19f450da (diff) | |
| parent | 091bd738d79d5485936578ed2cb7edb96efbc80f (diff) | |
| download | libgit2-853ba203208fcb4e7c3765f53a4d17a3db77f160.tar.gz | |
Merge pull request #6073 from libgit2/ethomson/attr_lookups
Diffstat (limited to 'include/git2')
| -rw-r--r-- | include/git2/repository.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/include/git2/repository.h b/include/git2/repository.h index e69901644..8d1cffc9b 100644 --- a/include/git2/repository.h +++ b/include/git2/repository.h @@ -762,13 +762,15 @@ GIT_EXTERN(int) git_repository_mergehead_foreach( * * @param out Output value of calculated SHA * @param repo Repository pointer - * @param path Path to file on disk whose contents should be hashed. If the - * repository is not NULL, this can be a relative path. + * @param path Path to file on disk whose contents should be hashed. This + * may be an absolute path or a relative path, in which case it + * will be treated as a path within the working directory. * @param type The object type to hash as (e.g. GIT_OBJECT_BLOB) * @param as_path The path to use to look up filtering rules. If this is - * NULL, then the `path` parameter will be used instead. If - * this is passed as the empty string, then no filters will be - * applied when calculating the hash. + * an empty string then no filters will be applied when + * calculating the hash. If this is `NULL` and the `path` + * parameter is a file within the repository's working + * directory, then the `path` will be used. * @return 0 on success, or an error code */ GIT_EXTERN(int) git_repository_hashfile( |