Commit 53c2296bfed972026809803415944b4dd4eff6d3

Edward Thomson 2015-08-31T19:41:43

iterator: better document GIT_DIFF_DISABLE_PATHSPEC_MATCH

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
diff --git a/include/git2/diff.h b/include/git2/diff.h
index 4912121..a0f6db3 100644
--- a/include/git2/diff.h
+++ b/include/git2/diff.h
@@ -129,10 +129,12 @@ typedef enum {
 	 */
 	GIT_DIFF_INCLUDE_CASECHANGE = (1u << 11),
 
-	/** If the pathspec is set in the diff options, this flags means to
-	 *  use exact prefix matches instead of an fnmatch pattern.  Each
-	 *  path in the list must either be a full filename or a subdirectory
-	 *  prefix.
+	/** If the pathspec is set in the diff options, this flags indicates
+	 *  that the paths will be treated as literal paths instead of
+	 *  fnmatch patterns.  Each path in the list must either be a full
+	 *  path to a file or a directory.  (A trailing slash indicates that
+	 *  the path will _only_ match a directory).  If a directory is
+	 *  specified, all children will be included.
 	 */
 	GIT_DIFF_DISABLE_PATHSPEC_MATCH = (1u << 12),