normalize_path_copy(): document "dst" size expectations
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 <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
Jan 30, 2020 at 04:52 UTC
9734b74a8f9e327e02762024596961209cf989d5
1 file changed
+2
path.c
+2
@@ -1077,6 +1077,8 @@ const char *remove_leading_path(const char *in, const char *prefix)
1077
1078
/*
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.
1082
*
1083
* Performs the following normalizations on src, storing the result in dst:
1084
* - Ensures that components are separated by '/' (Windows only)