summaryrefslogtreecommitdiff
path: root/include/git2/diff.h
diff options
context:
space:
mode:
authorBen Straub <bs@github.com>2013-12-06 13:39:08 -0800
committerBen Straub <bs@github.com>2013-12-06 13:39:08 -0800
commita7c83aec2149a4885bfac032859142e8a62bceab (patch)
treec76994c45d92d33769b9b4e0cf046c60832bdf03 /include/git2/diff.h
parent7fb4147f1f7e64d7544e574998d5cec04077dfc4 (diff)
downloadlibgit2-a7c83aec2149a4885bfac032859142e8a62bceab.tar.gz
Clarify docs
Diffstat (limited to 'include/git2/diff.h')
-rw-r--r--include/git2/diff.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/git2/diff.h b/include/git2/diff.h
index 1654523c8..315cc1215 100644
--- a/include/git2/diff.h
+++ b/include/git2/diff.h
@@ -577,9 +577,9 @@ typedef struct {
unsigned int version;
/**
- * 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.
+ * Combination of git_diff_find_t values (default FIND_BY_CONFIG).
+ * Note that if you don't explicitly set this, `diff.renames` could be set
+ * to false, resulting in `git_diff_find_similar` doing nothing.
*/
uint32_t flags;