From 56e743426b183d8aea8f4caa363e7f3c7da27278 Mon Sep 17 00:00:00 2001 From: Elijah Newren Date: Sun, 2 Aug 2020 03:14:27 +0000 Subject: merge-recursive: fix unclear and outright wrong comments Commits 7c0a6c8e47 ("merge-recursive: move some definitions around to clean up the header", 2019-08-17), and b4db8a2b76 ("merge-recursive: remove useless parameter in merge_trees()", 2019-08-17) added some useful documentation to the functions, but had a few places where the new comments were unclear or even misleading. Fix those comments. Signed-off-by: Elijah Newren Signed-off-by: Junio C Hamano --- merge-recursive.c | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'merge-recursive.c') diff --git a/merge-recursive.c b/merge-recursive.c index 36948eafb7..01c633d807 100644 --- a/merge-recursive.c +++ b/merge-recursive.c @@ -3529,8 +3529,9 @@ static struct commit_list *reverse_commit_list(struct commit_list *list) } /* - * Merge the commits h1 and h2, return the resulting virtual - * commit object and a flag indicating the cleanness of the merge. + * Merge the commits h1 and h2, returning a flag (int) indicating the + * cleanness of the merge. Also, if opt->priv->call_depth, create a + * virtual commit and write its location to *result. */ static int merge_recursive_internal(struct merge_options *opt, struct commit *h1, -- cgit v1.2.3