[PATCHv2 3/8] Document pre-condition for tree_entry_interesting

From: Elijah Newren <newren@gmail.com>
Date: Aug 26, 2010, 06:21 UTC
Message-ID: <1282803711-10253-4-git-send-email-newren@gmail.com>
In-Reply-To: <1282803711-10253-1-git-send-email-newren@gmail.com>

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 <newren@gmail.com>
---
 tree-diff.c |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)

diff --git a/tree-diff.c b/tree-diff.c
index 2fb670b..75b1480 100644
--- 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

-- 
1.7.2.2.45.ga60f