Clarify default value and behavior

710f3838 · Ben Straub · 628e92cd · 710f3838
Commit 710f3838 authored Dec 06, 2013 by Ben Straub
Hide whitespace changes
Inline Side-by-side

Showing with 5 additions and 1 deletions

include/git2/diff.h
+5 -1

No files found.
--- 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) */