Google Git
Sign in
googlers / jrn / git / eaa0fd658442c2b83dfad918d636bba3ca3b4087 / . / Documentation / git-check-attr.txt
blob: 84f41a8e82590f54bca103a067a95348093844b5 [file] [log] [blame]
James Bowesb568a502007-04-14 21:27:20 -0400[diff] [blame]1git-check-attr(1)
2=================
3
4NAME
5----
Matt Kraai0d641f72008-11-07 04:26:55 -0800[diff] [blame]6git-check-attr - Display gitattributes information
James Bowesb568a502007-04-14 21:27:20 -0400[diff] [blame]7
8
9SYNOPSIS
10--------
Jonas Fonsecae7108fc2008-10-15 09:11:52 +0200[diff] [blame]11[verse]
Robert P. J. Dayde613052018-05-24 16:11:39 -0400[diff] [blame]12'git check-attr' [-a | --all | <attr>...] [--] <pathname>...
13'git check-attr' --stdin [-z] [-a | --all | <attr>...]
James Bowesb568a502007-04-14 21:27:20 -0400[diff] [blame]14
15DESCRIPTION
16-----------
David J. Mellor3460a602009-03-22 18:00:16 -0700[diff] [blame]17For every pathname, this command will list if each attribute is 'unspecified',
James Bowesb568a502007-04-14 21:27:20 -0400[diff] [blame]18'set', or 'unset' as a gitattribute on that pathname.
19
20OPTIONS
21-------
Michael Haggerty4ca0f182011-08-04 06:36:30 +0200[diff] [blame]22-a, --all::
23 List all attributes that are associated with the specified
24 paths. If this option is used, then 'unspecified' attributes
25 will not be included in the output.
26
Jay Soffianb2b3e9c2011-09-22 17:44:20 -0400[diff] [blame]27--cached::
28 Consider `.gitattributes` in the index only, ignoring the working tree.
29
Dmitry Potapovb4666852008-10-07 04:16:52 +0400[diff] [blame]30--stdin::
Junio C Hamano33e8fc82015-10-16 11:27:42 -0700[diff] [blame]31 Read pathnames from the standard input, one per line,
32 instead of from the command-line.
Dmitry Potapovb4666852008-10-07 04:16:52 +0400[diff] [blame]33
34-z::
Elijah Newren031fd4b2019-11-05 17:07:20 +0000[diff] [blame]35 The output format is modified to be machine-parsable.
Junio C Hamanof7cd8c52013-07-11 23:02:40 -0700[diff] [blame]36 If `--stdin` is also given, input paths are separated
37 with a NUL character instead of a linefeed character.
Dmitry Potapovb4666852008-10-07 04:16:52 +0400[diff] [blame]38
James Bowesb568a502007-04-14 21:27:20 -0400[diff] [blame]39\--::
David J. Mellor3460a602009-03-22 18:00:16 -0700[diff] [blame]40 Interpret all preceding arguments as attributes and all following
Michael Haggertyca64d062011-08-04 06:36:32 +0200[diff] [blame]41 arguments 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.
James Bowesb568a502007-04-14 21:27:20 -0400[diff] [blame]46
Jonas Fonseca57825662008-10-15 09:10:58 +0200[diff] [blame]47OUTPUT
48------
49
50The output is of the form:
51<path> COLON SP <attribute> COLON SP <info> LF
52
Junio C Hamanof7cd8c52013-07-11 23:02:40 -0700[diff] [blame]53unless `-z` is in effect, in which case NUL is used as delimiter:
54<path> NUL <attribute> NUL <info> NUL
55
56
David J. Mellor3460a602009-03-22 18:00:16 -0700[diff] [blame]57<path> is the path of a file being queried, <attribute> is an attribute
Jonas Fonseca57825662008-10-15 09:10:58 +0200[diff] [blame]58being queried and <info> can be either:
59
60'unspecified';; when the attribute is not defined for the path.
David J. Mellor3460a602009-03-22 18:00:16 -0700[diff] [blame]61'unset';; when the attribute is defined as false.
62'set';; when the attribute is defined as true.
Jonas Fonseca57825662008-10-15 09:10:58 +0200[diff] [blame]63<value>;; when a value has been assigned to the attribute.
64
Adam Spiersf1ed7fe2013-04-11 13:05:13 +0100[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
Jonas Fonseca57825662008-10-15 09:10:58 +0200[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
Michael Haggerty4ca0f182011-08-04 06:36:30 +0200[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
David J. Mellor3460a602009-03-22 18:00:16 -0700[diff] [blame]101* Listing an attribute for multiple files:
Jonas Fonseca57825662008-10-15 09:10:58 +0200[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---------------
James Bowesb568a502007-04-14 21:27:20 -0400[diff] [blame]113
Junio C Hamano0e545f72007-12-22 23:14:59 -0800[diff] [blame]114SEE ALSO
115--------
Dan McGee5162e692007-12-29 00:20:38 -0600[diff] [blame]116linkgit:gitattributes[5].
Junio C Hamano0e545f72007-12-22 23:14:59 -0800[diff] [blame]117
James Bowesb568a502007-04-14 21:27:20 -0400[diff] [blame]118GIT
119---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200[diff] [blame]120Part of the linkgit:git[1] suite