diff options
| author | Nguyễn Thái Ngọc Duy <pclouds@gmail.com> | 2013-07-14 15:35:36 +0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-07-15 10:56:07 -0700 |
| commit | 8f4f8f4579fe8cc630e118cc736de2b8d5cf8e34 (patch) | |
| tree | 84c3f6e022bd7c4e81d05ca725a469e72806d00e /Documentation/technical/api-setup.txt | |
| parent | dad2586a6b30da902d5f1979221eccc474425a7a (diff) | |
| download | git-8f4f8f4579fe8cc630e118cc736de2b8d5cf8e34.tar.gz | |
guard against new pathspec magic in pathspec matching code
GUARD_PATHSPEC() marks pathspec-sensitive code, basically all those
that touch anything in 'struct pathspec' except fields "nr" and
"original". GUARD_PATHSPEC() is not supposed to fail. It's mainly to
help the designers catch unsupported codepaths.
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/technical/api-setup.txt')
| -rw-r--r-- | Documentation/technical/api-setup.txt | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/technical/api-setup.txt b/Documentation/technical/api-setup.txt index 90d1aff625..540e455689 100644 --- a/Documentation/technical/api-setup.txt +++ b/Documentation/technical/api-setup.txt @@ -28,3 +28,22 @@ parse_pathspec(). This function takes several arguments: - prefix and args come from cmd_* functions get_pathspec() is obsolete and should never be used in new code. + +parse_pathspec() helps catch unsupported features and reject them +politely. At a lower level, different pathspec-related functions may +not support the same set of features. Such pathspec-sensitive +functions are guarded with GUARD_PATHSPEC(), which will die in an +unfriendly way when an unsupported feature is requested. + +The command designers are supposed to make sure that GUARD_PATHSPEC() +never dies. They have to make sure all unsupported features are caught +by parse_pathspec(), not by GUARD_PATHSPEC. grepping GUARD_PATHSPEC() +should give the designers all pathspec-sensitive codepaths and what +features they support. + +A similar process is applied when a new pathspec magic is added. The +designer lifts the GUARD_PATHSPEC restriction in the functions that +support the new magic. At the same time (s)he has to make sure this +new feature will be caught at parse_pathspec() in commands that cannot +handle the new magic in some cases. grepping parse_pathspec() should +help. |