pathspec doc: parse_pathspec does not maintain references to args
The command line arguments passed to main() are valid for the life of a program, but the same is not true for all other argv-style arrays (e.g. when a caller creates an argv_array). Clarify that parse_pathspec does not rely on the argv passed to it to remain valid. This makes it easier to tell that callers like "git rev-list --stdin" are safe and ensures that that is more likely to remain true as the implementation of parse_pathspec evolves. Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
Sep 20, 2017 at 21:41 UTC
29c0e902a803d8865b9421edadf2ca7c565e355c
2 files changed
+7
-4
pathspec.c
-4
@@ -526,10 +526,6 @@ static void NORETURN unsupported_magic(const char *pattern,
526
pattern, sb.buf);
527
}
528
529
-/*
530
- * Given command line arguments and a prefix, convert the input to
531
- * pathspec. die() if any magic in magic_mask is used.
532
- */
529
void parse_pathspec(struct pathspec *pathspec,
530
unsigned magic_mask, unsigned flags,
531
const char *prefix, const char **argv)
pathspec.h
+7
@@ -70,6 +70,13 @@ struct pathspec {
70
*/
71
#define PATHSPEC_LITERAL_PATH (1<<6)
72
73
+/*
74
+ * Given command line arguments and a prefix, convert the input to
75
+ * pathspec. die() if any magic in magic_mask is used.
76
+ *
77
+ * Any arguments used are copied. It is safe for the caller to modify
78
+ * or free 'prefix' and 'args' after calling this function.
79
+ */
80
extern void parse_pathspec(struct pathspec *pathspec,
81
unsigned magic_mask,
82
unsigned flags,