path: root/merge-recursive.c
diff options
authorElijah Newren <>2020-08-02 03:14:27 (GMT)
committerJunio C Hamano <>2020-08-02 18:03:57 (GMT)
commit56e743426b183d8aea8f4caa363e7f3c7da27278 (patch)
treee06beda6ab86dd1c9bf913c1acfeb6099e48c37a /merge-recursive.c
parentb3d7a52fac39193503a0b6728771d1bf6a161464 (diff)
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 <>
Diffstat (limited to 'merge-recursive.c')
1 files changed, 3 insertions, 2 deletions
diff --git a/merge-recursive.c b/merge-recursive.c
index 36948ea..01c633d 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,