add parse_pathspec() that converts cmdline args to struct pathspec
[git/git.git] / Documentation / technical / api-setup.txt
CommitLineData
530e741c
JH
1setup API
2=========
3
4Talk 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
14Pathspec
15--------
16
17See glossary-context.txt for the syntax of pathspec. In memory, a
18pathspec set is represented by "struct pathspec" and is prepared by
19parse_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
30get_pathspec() is obsolete and should never be used in new code.