Gecko [ 122.154.134.11 ]

Name	Size	Permission
api-allocation-growing.html	8.14 KB	-rw-r--r--
api-allocation-growing.txt	935 B	-rw-r--r--
api-builtin.html	9.89 KB	-rw-r--r--
api-builtin.txt	1.95 KB	-rw-r--r--
api-decorate.html	6.95 KB	-rw-r--r--
api-decorate.txt	60 B	-rw-r--r--
api-diff.html	14.79 KB	-rw-r--r--
api-diff.txt	5.22 KB	-rw-r--r--
api-directory-listing.html	9.86 KB	-rw-r--r--
api-directory-listing.txt	1.88 KB	-rw-r--r--
api-gitattributes.html	11.45 KB	-rw-r--r--
api-gitattributes.txt	2.96 KB	-rw-r--r--
api-grep.html	7.02 KB	-rw-r--r--
api-grep.txt	76 B	-rw-r--r--
api-hash.html	9.03 KB	-rw-r--r--
api-hash.txt	1.4 KB	-rw-r--r--
api-history-graph.html	14.49 KB	-rw-r--r--
api-history-graph.txt	5.95 KB	-rw-r--r--
api-in-core-index.html	7.68 KB	-rw-r--r--
api-in-core-index.txt	457 B	-rw-r--r--
api-index-skel.txt	443 B	-rw-r--r--
api-index.html	8.66 KB	-rw-r--r--
api-index.sh	611 B	-rw-r--r--
api-index.txt	1.37 KB	-rw-r--r--
api-lockfile.html	10.62 KB	-rw-r--r--
api-lockfile.txt	2.92 KB	-rw-r--r--
api-object-access.html	7.45 KB	-rw-r--r--
api-object-access.txt	342 B	-rw-r--r--
api-parse-options.html	20.12 KB	-rw-r--r--
api-parse-options.txt	8.77 KB	-rw-r--r--
api-quote.html	7.13 KB	-rw-r--r--
api-quote.txt	145 B	-rw-r--r--
api-remote.html	11.8 KB	-rw-r--r--
api-remote.txt	3.3 KB	-rw-r--r--
api-revision-walking.html	10.13 KB	-rw-r--r--
api-revision-walking.txt	2.25 KB	-rw-r--r--
api-run-command.html	18.92 KB	-rw-r--r--
api-run-command.txt	8.22 KB	-rw-r--r--
api-setup.html	7.23 KB	-rw-r--r--
api-setup.txt	180 B	-rw-r--r--
api-strbuf.html	20.38 KB	-rw-r--r--
api-strbuf.txt	8.8 KB	-rw-r--r--
api-string-list.html	13.08 KB	-rw-r--r--
api-string-list.txt	4.01 KB	-rw-r--r--
api-tree-walking.html	13.46 KB	-rw-r--r--
api-tree-walking.txt	4.2 KB	-rw-r--r--
api-xdiff-interface.html	7.02 KB	-rw-r--r--
api-xdiff-interface.txt	139 B	-rw-r--r--
pack-format.txt	5.41 KB	-rw-r--r--
pack-heuristics.txt	17.81 KB	-rw-r--r--
pack-protocol.txt	18.97 KB	-rw-r--r--
protocol-capabilities.txt	7.09 KB	-rw-r--r--
protocol-common.txt	2.71 KB	-rw-r--r--
racy-git.txt	8.63 KB	-rw-r--r--
send-pack-pipeline.txt	1.9 KB	-rw-r--r--
shallow.txt	2.01 KB	-rw-r--r--
trivial-merge.txt	4.15 KB	-rw-r--r--

Code Editor : api-gitattributes.txt

gitattributes API
=================

gitattributes mechanism gives a uniform way to associate various
attributes to set of paths.

Data Structure
--------------

`struct git_attr`::

An attribute is an opaque object that is identified by its name.
	Pass the name and its length to `git_attr()` function to obtain
	the object of this type.  The internal representation of this
	structure is of no interest to the calling programs.

`struct git_attr_check`::

This structure represents a set of attributes to check in a call
	to `git_checkattr()` function, and receives the results.

Calling Sequence
----------------

* Prepare an array of `struct git_attr_check` to define the list of
  attributes you would want to check.  To populate this array, you would
  need to define necessary attributes by calling `git_attr()` function.

* Call git_checkattr() to check the attributes for the path.

* Inspect `git_attr_check` structure to see how each of the attribute in
  the array is defined for the path.

Attribute Values
----------------

An attribute for a path can be in one of four states: Set, Unset,
Unspecified or set to a string, and `.value` member of `struct
git_attr_check` records it.  There are three macros to check these:

`ATTR_TRUE()`::

Returns true if the attribute is Set for the path.

`ATTR_FALSE()`::

Returns true if the attribute is Unset for the path.

`ATTR_UNSET()`::

Returns true if the attribute is Unspecified for the path.

If none of the above returns true, `.value` member points at a string
value of the attribute for the path.

Example
-------

To see how attributes "crlf" and "indent" are set for different paths.

. Prepare an array of `struct git_attr_check` with two elements (because
  we are checking two attributes).  Initialize their `attr` member with
  pointers to `struct git_attr` obtained by calling `git_attr()`:

------------
static struct git_attr_check check[2];
static void setup_check(void)
{
	if (check[0].attr)
		return; /* already done */
	check[0].attr = git_attr("crlf", 4);
	check[1].attr = git_attr("ident", 5);
}
------------

. Call `git_checkattr()` with the prepared array of `struct git_attr_check`:

------------
	const char *path;

setup_check();
	git_checkattr(path, ARRAY_SIZE(check), check);
------------

. Act on `.value` member of the result, left in `check[]`:

------------
	const char *value = check[0].value;

if (ATTR_TRUE(value)) {
		The attribute is Set, by listing only the name of the
		attribute in the gitattributes file for the path.
	} else if (ATTR_FALSE(value)) {
		The attribute is Unset, by listing the name of the
		attribute prefixed with a dash - for the path.
	} else if (ATTR_UNSET(value)) {
		The attribute is not set nor unset for the path.
	} else if (!strcmp(value, "input")) {
		If none of ATTR_TRUE(), ATTR_FALSE(), or ATTR_UNSET() is
		true, the value is a string set in the gitattributes
		file for the path by saying "attr=value".
	} else if (... other check using value as string ...) {
		...
	}
------------

(JC)

${this.title}

Code Editor : api-gitattributes.txt