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>
This commit is contained in:
Jeff King 2020-01-30 04:52:19 -05:00 committed by Junio C Hamano
parent d0654dc308
commit 9734b74a8f

2
path.c
View File

@ -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)