Commit 710f383868cef86ff837340c698b1672c7902486

Ben Straub 2013-12-06T09:32:09

Clarify default value and behavior

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/git2/diff.h b/include/git2/diff.h
index 312702b..1654523 100644
--- a/include/git2/diff.h
+++ b/include/git2/diff.h
@@ -576,7 +576,11 @@ typedef struct {
 typedef struct {
 	unsigned int version;
 
-	/** Combination of git_diff_find_t values (default FIND_RENAMES) */
+	/**
+	 * Combination of git_diff_find_t values (default FIND_BY_CONFIG).  Note
+	 * that if the configuration value is falsy, this will result in
+	 * `git_diff_find_similar` doing nothing. 
+	 */
 	uint32_t flags;
 
 	/** Similarity to consider a file renamed (default 50) */