normalize_path_copy(): document "dst" size expectations

peff · gitster · commit 9734b74a8f9e · 2020-01-30T13:45:58.000-08:00
We take a "dst" buffer to write into, but there's no matching "len"
parameter. The hidden assumption is that normalizing always makes things
smaller, so we're OK as long as "dst" is at least as big as "src". Let's
document that explicitly.

Signed-off-by: Jeff King &lt;peff@peff.net&gt;
Signed-off-by: Junio C Hamano &lt;gitster@pobox.com&gt;
diff --git a/path.c b/path.c
@@ -1077,6 +1077,8 @@ const char *remove_leading_path(const char *in, const char *prefix)
 
 /*
  * It is okay if dst == src, but they should not overlap otherwise.
+ * The "dst" buffer must be at least as long as "src"; normalizing may shrink
+ * the size of the path, but will never grow it.
  *
  * Performs the following normalizations on src, storing the result in dst:
  * - Ensures that components are separated by '/' (Windows only)

Original file line number	Diff line number	Diff line change
`@@ -1077,6 +1077,8 @@ const char remove_leading_path(const char in, const char *prefix)`
`1077`	`1077`
`1078`	`1078`	`/*`
`1079`	`1079`	`* It is okay if dst == src, but they should not overlap otherwise.`
	`1080`	`+ * The "dst" buffer must be at least as long as "src"; normalizing may shrink`
	`1081`	`+ * the size of the path, but will never grow it.`
`1080`	`1082`	`*`
`1081`	`1083`	`* Performs the following normalizations on src, storing the result in dst:`
`1082`	`1084`	`* - Ensures that components are separated by '/' (Windows only)`