diff options
| author | Jonathan Nieder <jrnieder@gmail.com> | 2017-09-21 04:41:12 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-09-21 05:05:00 (GMT) |
| commit | 29c0e902a803d8865b9421edadf2ca7c565e355c (patch) | |
| tree | 6d4948dbea4d83ebe123ee336285d7dfdd620529 /pathspec.h | |
| parent | 7fa3c2ad6d06428dcbd801ced55dffd22027cc96 (diff) | |
| download | git-29c0e902a803d8865b9421edadf2ca7c565e355c.zip git-29c0e902a803d8865b9421edadf2ca7c565e355c.tar.gz git-29c0e902a803d8865b9421edadf2ca7c565e355c.tar.bz2 | |
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>
Diffstat (limited to 'pathspec.h')
| -rw-r--r-- | pathspec.h | 7 |
1 files changed, 7 insertions, 0 deletions
@@ -70,6 +70,13 @@ struct pathspec { */ #define PATHSPEC_LITERAL_PATH (1<<6) +/* + * Given command line arguments and a prefix, convert the input to + * pathspec. die() if any magic in magic_mask is used. + * + * Any arguments used are copied. It is safe for the caller to modify + * or free 'prefix' and 'args' after calling this function. + */ extern void parse_pathspec(struct pathspec *pathspec, unsigned magic_mask, unsigned flags, |