Google Git
Sign in
chromium / external / gitster / git-htmldocs / 328b8c903d3158188a5d7dff974bcd6174a8ed32 / . / git-check-attr.txt
blob: 3c0578217ba7f92f823e545021c5c06c31566f0d [file] [log] [blame]
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]1git-check-attr(1)
2=================
3
4NAME
5----
Junio C Hamano9bd39c42008-11-13 01:54:44[diff] [blame]6git-check-attr - Display gitattributes information
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]7
8
9SYNOPSIS
10--------
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]11[verse]
Junio C Hamanoc9cb5172018-06-01 07:13:44[diff] [blame]12'git check-attr' [-a | --all | <attr>...] [--] <pathname>...
13'git check-attr' --stdin [-z] [-a | --all | <attr>...]
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]14
15DESCRIPTION
16-----------
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]17For every pathname, this command will list if each attribute is 'unspecified',
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]18'set', or 'unset' as a gitattribute on that pathname.
19
20OPTIONS
21-------
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]22-a, --all::
23List all attributes that are associated with the specified
24paths. If this option is used, then 'unspecified' attributes
25will not be included in the output.
26
Junio C Hamano8fb66e52011-10-05 20:59:51[diff] [blame]27--cached::
28Consider `.gitattributes` in the index only, ignoring the working tree.
29
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]30--stdin::
Junio C Hamanodaf0aae2015-10-26 23:14:30[diff] [blame]31Read pathnames from the standard input, one per line,
32instead of from the command-line.
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]33
34-z::
Junio C Hamano535ed7a2013-09-04 20:35:57[diff] [blame]35The output format is modified to be machine-parseable.
36If `--stdin` is also given, input paths are separated
37with a NUL character instead of a linefeed character.
Junio C Hamano7d06a8a2008-10-20 05:42:33[diff] [blame]38
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]39\--::
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]40Interpret all preceding arguments as attributes and all following
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]41arguments as path names.
42
43If none of `--stdin`, `--all`, or `--` is used, the first argument
44will be treated as an attribute and the rest of the arguments as
45pathnames.
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]46
Junio C Hamanocbb30862008-10-17 10:03:42[diff] [blame]47OUTPUT
48------
49
50The output is of the form:
51<path> COLON SP <attribute> COLON SP <info> LF
52
Junio C Hamano535ed7a2013-09-04 20:35:57[diff] [blame]53unless `-z` is in effect, in which case NUL is used as delimiter:
54<path> NUL <attribute> NUL <info> NUL
55
56
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]57<path> is the path of a file being queried, <attribute> is an attribute
Junio C Hamanocbb30862008-10-17 10:03:42[diff] [blame]58being queried and <info> can be either:
59
60'unspecified';; when the attribute is not defined for the path.
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]61'unset';; when the attribute is defined as false.
62'set';; when the attribute is defined as true.
Junio C Hamanocbb30862008-10-17 10:03:42[diff] [blame]63<value>;; when a value has been assigned to the attribute.
64
Junio C Hamanoc7102962013-05-29 23:57:17[diff] [blame]65Buffering happens as documented under the `GIT_FLUSH` option in
66linkgit:git[1]. The caller is responsible for avoiding deadlocks
67caused by overfilling an input buffer or reading from an empty output
68buffer.
69
Junio C Hamanocbb30862008-10-17 10:03:42[diff] [blame]70EXAMPLES
71--------
72
73In the examples, the following '.gitattributes' file is used:
74---------------
75*.java diff=java -crlf myAttr
76NoMyAttr.java !myAttr
77README caveat=unspecified
78---------------
79
80* Listing a single attribute:
81---------------
82$ git check-attr diff org/example/MyClass.java
83org/example/MyClass.java: diff: java
84---------------
85
86* Listing multiple attributes for a file:
87---------------
88$ git check-attr crlf diff myAttr -- org/example/MyClass.java
89org/example/MyClass.java: crlf: unset
90org/example/MyClass.java: diff: java
91org/example/MyClass.java: myAttr: set
92---------------
93
Junio C Hamanof7279012011-08-18 06:13:13[diff] [blame]94* Listing all attributes for a file:
95---------------
96$ git check-attr --all -- org/example/MyClass.java
97org/example/MyClass.java: diff: java
98org/example/MyClass.java: myAttr: set
99---------------
100
Junio C Hamano1de75722009-03-26 08:39:38[diff] [blame]101* Listing an attribute for multiple files:
Junio C Hamanocbb30862008-10-17 10:03:42[diff] [blame]102---------------
103$ git check-attr myAttr -- org/example/MyClass.java org/example/NoMyAttr.java
104org/example/MyClass.java: myAttr: set
105org/example/NoMyAttr.java: myAttr: unspecified
106---------------
107
108* Not all values are equally unambiguous:
109---------------
110$ git check-attr caveat README
111README: caveat: unspecified
112---------------
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]113
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]114SEE ALSO
115--------
Junio C Hamano35738e82008-01-07 07:55:46[diff] [blame]116linkgit:gitattributes[5].
Junio C Hamanof556fc22007-12-23 08:16:38[diff] [blame]117
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]118GIT
119---
Junio C Hamanof7c042d2008-06-06 22:50:53[diff] [blame]120Part of the linkgit:git[1] suite