Document pre-condition for tree_entry_interesting

newren · gitster · commit b6b987a09457 · 2010-08-26T09:53:35.000-07:00
tree_entry_interesting will fail to find appropriate matches if the base
directory path is not terminated with a slash.  Knowing this earlier would
have saved me some debugging time.

Signed-off-by: Elijah Newren &lt;newren@gmail.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/tree-diff.c b/tree-diff.c
@@ -85,6 +85,8 @@ static int compare_tree_entry(struct tree_desc *t1, struct tree_desc *t2, const
 /*
  * Is a tree entry interesting given the pathspec we have?
  *
+ * Pre-condition: baselen == 0 || base[baselen-1] == '/'
+ *
  * Return:
  *  - 2 for "yes, and all subsequent entries will be"
  *  - 1 for yes

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,8 @@ static int compare_tree_entry(struct tree_desc t1, struct tree_desc t2, const`
`85`	`85`	`/*`
`86`	`86`	`* Is a tree entry interesting given the pathspec we have?`
`87`	`87`	`*`
	`88`	`+ * Pre-condition: baselen == 0 \|\| base[baselen-1] == '/'`
	`89`	`+ *`
`88`	`90`	`* Return:`
`89`	`91`	`* - 2 for "yes, and all subsequent entries will be"`
`90`	`92`	`* - 1 for yes`