Commit f55af775ab9b6b20e66607d502ff8bcdb0b72b7d

Sven Strickroth 2012-09-22T01:16:10

Make clear that git_odb_hashfile does not use filters Signed-off-by: Sven Strickroth <email@cs-ware.de>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/git2/odb.h b/include/git2/odb.h
index 1919f61..c6e7357 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