summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Straub <bs@github.com>2013-12-06 09:32:09 -0800
committerBen Straub <bs@github.com>2013-12-06 09:32:09 -0800
commit710f383868cef86ff837340c698b1672c7902486 (patch)
treee83e484ca9c9f15630fe0d8f98bb5b127f5ee9ca
parent628e92cdb31cb3561549671ea5346a347f2addcd (diff)
downloadlibgit2-710f383868cef86ff837340c698b1672c7902486.tar.gz
Clarify default value and behavior
-rw-r--r--include/git2/diff.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/git2/diff.h b/include/git2/diff.h
index 312702bc2..1654523c8 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) */