[PATCH 05/14] diff: add a comment about combine_diff_path.parent.path

From: Jeff King <peff@peff.net>
Date: Jan 9, 2025, 08:42 UTC
Message-ID: <20250109084248.GE2748836@coredump.intra.peff.net>
In-Reply-To: <20250109082723.GA2748497@coredump.intra.peff.net>

We only fill in the per-parent "path" field when it differs from what's in combine_diff_path.path (and even then only when the option is appropriate). Let's document that.

Suggested-by: Wink Saville <wink@saville.com>
Signed-off-by: Jeff King <peff@peff.net>
---
 diff.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/diff.h b/diff.h
index f5f6ea00fb..60e7db4ad6 100644
--- a/diff.h
+++ b/diff.h
@@ -480,6 +480,12 @@ struct combine_diff_path {
 		char status;
 		unsigned int mode;
 		struct object_id oid;
+		/*
+		 * This per-parent path is filled only when doing a combined
+		 * diff with revs.combined_all_paths set, and only if the path
+		 * differs from the post-image (e.g., a rename or copy).
+		 * Otherwise it is left NULL.
+		 */
 		char *path;
 	} parent[FLEX_ARRAY];
 };

-- 
2.48.0.rc2.413.gc1c80375a3