The existing comment in `parse_commit_buffer()` mentioned a "leftover
from an earlier failed parse", which could be confusing to new readers.
It implied an error state rather than the intended cleanup before
re-parsing a commit.
Clarifying the comment makes it explicit that we reset the parent list
to ensure a clean state before re-parsing, which improves readability
and avoids misunderstanding during future maintenance.
Signed-off-by: Okhuomon Ajayi <redacted>
---
commit.c | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/commit.c b/commit.c
index 16d91b2bfc..af20ca7c3d 100644
--- a/commit.c
+++ b/commit.c
@@ -475,10 +475,9 @@ int parse_commit_buffer(struct repository *r, struct commit *item, const void *b
if (item->object.parsed)
return 0;
/*
- * Presumably this is leftover from an earlier failed parse;
- * clear it out in preparation for us re-parsing (we'll hit the
- * same error, but that's good, since it lets our caller know
- * the result cannot be trusted.
+ * Reset the parent list before re-parsing to ensure a clear
+ * commit state. This avoids carrying over data from a previous
+ * incomplete or invalid parse.
*/
free_commit_list(item->parents);
item->parents = NULL;
--
2.43.0