man7.org > Linux > man-pages

Linux/UNIX system programming training

git-check-attr(1) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | OUTPUT | EXAMPLES | SEE ALSO | GIT | COLOPHON 

GIT-CHECK-ATTR(1)              Git Manual              GIT-CHECK-ATTR(1)

NAME         top

       git-check-attr - Display gitattributes information

SYNOPSIS         top

       git check-attr [--source <tree-ish>] [-a | --all | <attr>...] [--] <pathname>...
       git check-attr --stdin [-z] [--source <tree-ish>] [-a | --all | <attr>...]

DESCRIPTION         top

       For every pathname, this command will list if each attribute is
       unspecified, set, or unset as a gitattribute on that pathname.

OPTIONS         top

       -a, --all
           List all attributes that are associated with the specified
           paths. If this option is used, then unspecified attributes
           will not be included in the output.

       --cached
           Consider .gitattributes in the index only, ignoring the
           working tree.

       --stdin
           Read pathnames from the standard input, one per line, instead
           of from the command line.

       -z
           The output format is modified to be machine-parsable. If
           --stdin is also given, input paths are separated with a NUL
           character instead of a linefeed character.

       --source=<tree-ish>
           Check attributes against the specified tree-ish. It is common
           to specify the source tree by naming a commit, branch, or tag
           associated with it.

       --
           Interpret all preceding arguments as attributes and all
           following arguments as path names.

       If none of --stdin, --all, or -- is used, the first argument will
       be treated as an attribute and the rest of the arguments as
       pathnames.

OUTPUT         top

       The output is of the form: <path> COLON SP <attribute> COLON SP
       <info> LF

       unless -z is in effect, in which case NUL is used as delimiter:
       <path> NUL <attribute> NUL <info> NUL

       <path> is the path of a file being queried, <attribute> is an
       attribute being queried, and <info> can be either:

       unspecified
           when the attribute is not defined for the path.

       unset
           when the attribute is defined as false.

       set
           when the attribute is defined as true.

       <value>
           when a value has been assigned to the attribute.

       Buffering happens as documented under the GIT_FLUSH option in
       git(1). The caller is responsible for avoiding deadlocks caused
       by overfilling an input buffer or reading from an empty output
       buffer.

EXAMPLES         top

       In the examples, the following .gitattributes file is used:

           *.java diff=java -crlf myAttr
           NoMyAttr.java !myAttr
           README caveat=unspecified

       •   Listing a single attribute:

           $ git check-attr diff org/example/MyClass.java
           org/example/MyClass.java: diff: java

       •   Listing multiple attributes for a file:

           $ git check-attr crlf diff myAttr -- org/example/MyClass.java
           org/example/MyClass.java: crlf: unset
           org/example/MyClass.java: diff: java
           org/example/MyClass.java: myAttr: set

       •   Listing all attributes for a file:

           $ git check-attr --all -- org/example/MyClass.java
           org/example/MyClass.java: diff: java
           org/example/MyClass.java: myAttr: set

       •   Listing an attribute for multiple files:

           $ git check-attr myAttr -- org/example/MyClass.java org/example/NoMyAttr.java
           org/example/MyClass.java: myAttr: set
           org/example/NoMyAttr.java: myAttr: unspecified

       •   Not all values are equally unambiguous:

           $ git check-attr caveat README
           README: caveat: unspecified

SEE ALSO         top

       gitattributes(5).

GIT         top

       Part of the git(1) suite

COLOPHON         top

       This page is part of the git (Git distributed version control
       system) project.  Information about the project can be found at
       ⟨http://git-scm.com/⟩.  If you have a bug report for this manual
       page, see ⟨http://git-scm.com/community⟩.  This page was obtained
       from the project's upstream Git repository
       ⟨https://github.com/git/git.git⟩ on 2024-06-14.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2024-06-12.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

Git 2.45.2.492.gd63586         2024-06-12              GIT-CHECK-ATTR(1)

Pages that refer to this page: git(1),  gitattributes(5)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI