[thirdparty/git.git] / Documentation / technical / api-setup.txt

setup API
=========

Talk about

* setup_git_directory()
* setup_git_directory_gently()
* is_inside_git_dir()
* is_inside_work_tree()
* setup_work_tree()

(Dscho)

Pathspec
--------

See glossary-context.txt for the syntax of pathspec. In memory, a
pathspec set is represented by "struct pathspec" and is prepared by
parse_pathspec(). This function takes several arguments:

- magic_mask specifies what features that are NOT supported by the
  following code. If a user attempts to use such a feature,
  parse_pathspec() can reject it early.

- flags specifies other things that the caller wants parse_pathspec to
  perform.

- prefix and args come from cmd_* functions

get_pathspec() is obsolete and should never be used in new code.
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
530e741c JH	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
	30	get_pathspec() is obsolete and should never be used in new code.