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 <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Elijah Newren
2020-08-02 03:14:27 +00:00
committed by Junio C Hamano
parent b3d7a52fac
commit 56e743426b
2 changed files with 9 additions and 9 deletions

View File

@ -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,