projects / thirdparty / git.git / blame
| Commit | Line | Data |
|---|---|---|
| 530e741c JH |
1 | setup API |
| 2 | ========= | |
| 3 | ||
| 4 | Talk about | |
| 5 | ||
| 6 | * setup_git_directory() | |
| 7 | * setup_git_directory_gently() | |
| 8 | * is_inside_git_dir() | |
| 9 | * is_inside_work_tree() | |
| 10 | * setup_work_tree() | |
| 530e741c JH |
11 | |
| 12 | (Dscho) | |
| 87323bda NTND |
13 | |
| 14 | Pathspec | |
| 15 | -------- | |
| 16 | ||
| 17 | See glossary-context.txt for the syntax of pathspec. In memory, a | |
| 18 | pathspec set is represented by "struct pathspec" and is prepared by | |
| 19 | parse_pathspec(). This function takes several arguments: | |
| 20 | ||
| 21 | - magic_mask specifies what features that are NOT supported by the | |
| 22 | following code. If a user attempts to use such a feature, | |
| 23 | parse_pathspec() can reject it early. | |
| 24 | ||
| 25 | - flags specifies other things that the caller wants parse_pathspec to | |
| 26 | perform. | |
| 27 | ||
| 28 | - prefix and args come from cmd_* functions | |
| 29 | ||
| 8f4f8f45 NTND |
30 | parse_pathspec() helps catch unsupported features and reject them |
| 31 | politely. At a lower level, different pathspec-related functions may | |
| 32 | not support the same set of features. Such pathspec-sensitive | |
| 33 | functions are guarded with GUARD_PATHSPEC(), which will die in an | |
| 34 | unfriendly way when an unsupported feature is requested. | |
| 35 | ||
| 36 | The command designers are supposed to make sure that GUARD_PATHSPEC() | |
| 37 | never dies. They have to make sure all unsupported features are caught | |
| 38 | by parse_pathspec(), not by GUARD_PATHSPEC. grepping GUARD_PATHSPEC() | |
| 39 | should give the designers all pathspec-sensitive codepaths and what | |
| 40 | features they support. | |
| 41 | ||
| 42 | A similar process is applied when a new pathspec magic is added. The | |
| 43 | designer lifts the GUARD_PATHSPEC restriction in the functions that | |
| 44 | support the new magic. At the same time (s)he has to make sure this | |
| 45 | new feature will be caught at parse_pathspec() in commands that cannot | |
| 46 | handle the new magic in some cases. grepping parse_pathspec() should | |
| 47 | help. |