summaryrefslogtreecommitdiff
path: root/include/git2/odb.h
diff options
context:
space:
mode:
authorSven Strickroth <email@cs-ware.de>2012-09-22 01:16:10 +0200
committerSven Strickroth <email@cs-ware.de>2012-09-22 01:16:10 +0200
commitf55af775ab9b6b20e66607d502ff8bcdb0b72b7d (patch)
treef087cdddb9fc0b967529cf985bd9ae69ae8aa204 /include/git2/odb.h
parent0cb24616eea3b92893b2a03e851a0db2c04862ef (diff)
downloadlibgit2-f55af775ab9b6b20e66607d502ff8bcdb0b72b7d.tar.gz
Make clear that git_odb_hashfile does not use filters
Signed-off-by: Sven Strickroth <email@cs-ware.de>
Diffstat (limited to 'include/git2/odb.h')
-rw-r--r--include/git2/odb.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/git2/odb.h b/include/git2/odb.h
index 1919f61a0..c6e73571b 100644
--- a/include/git2/odb.h
+++ b/include/git2/odb.h
@@ -279,8 +279,10 @@ GIT_EXTERN(int) git_odb_hash(git_oid *id, const void *data, size_t len, git_otyp
/**
* Read a file from disk and fill a git_oid with the object id
* that the file would have if it were written to the Object
- * Database as an object of the given type. Similar functionality
- * to git.git's `git hash-object` without the `-w` flag.
+ * Database as an object of the given type (w/o applying filters).
+ * Similar functionality to git.git's `git hash-object` without
+ * the `-w` flag, however, with the --no-filters flag.
+ * If you need filters, see git_repository_hashfile.
*
* @param out oid structure the result is written into.
* @param path file to read and determine object id for