ref-filter: fix outdated comment on in_commit_list

derrickstolee · gitster · commit 8fb572af5f4e · 2018-05-02T13:39:53.000+09:00
The in_commit_list() method does not check the parents of
the candidate for containment in the list. Fix the comment
that incorrectly states that it does.

Reported-by: Jakub Narebski &lt;jnareb@gmail.com&gt;
Signed-off-by: Derrick Stolee &lt;dstolee@microsoft.com&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/ref-filter.c b/ref-filter.c
@@ -1582,7 +1582,7 @@ static int in_commit_list(const struct commit_list *want, struct commit *c)
 }
 
 /*
- * Test whether the candidate or one of its parents is contained in the list.
+ * Test whether the candidate is contained in the list.
  * Do not recurse to find out, though, but return -1 if inconclusive.
  */
 static enum contains_result contains_test(struct commit *candidate,

Original file line number	Diff line number	Diff line change
`@@ -1582,7 +1582,7 @@ static int in_commit_list(const struct commit_list want, struct commit c)`
`1582`	`1582`	`}`
`1583`	`1583`
`1584`	`1584`	`/*`
`1585`		`- * Test whether the candidate or one of its parents is contained in the list.`
	`1585`	`+ * Test whether the candidate is contained in the list.`
`1586`	`1586`	`* Do not recurse to find out, though, but return -1 if inconclusive.`
`1587`	`1587`	`*/`
`1588`	`1588`	`static enum contains_result contains_test(struct commit *candidate,`