From: Jonas Fonseca Date: Wed, 15 Oct 2008 07:10:58 GMT Subject: [PATCH 1/2] git-check-attr(1): add output and example sections Message-ID: <20081015071058.GA32094@diku.dk> In-Reply-To: <7vabd6686n.fsf@gitster.siamese.dyndns.org> Plumbing tools should document what output can be expected. Signed-off-by: Jonas Fonseca --- Documentation/git-check-attr.txt | 50 ++++++++++++++++++++++++++++++++++++++ 1 files changed, 50 insertions(+), 0 deletions(-) Junio C Hamano wrote Tue, Oct 14, 2008: > Should this really have to depend on next? This is just topgit listing the patch dependencies. > Could you split this into two patches, one for 'maint' to describe the > output format, and another for 'next' (or 'dp/checkattr') to update the > SYNOPSIS part? Done. The example has been updated to also show '!' in action. diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt index 2b821f2..8460a87 100644 --- a/Documentation/git-check-attr.txt +++ b/Documentation/git-check-attr.txt @@ -22,6 +22,56 @@ OPTIONS arguments as path names. If not supplied, only the first argument will be treated as an attribute. +OUTPUT +------ + +The output is of the form: + COLON SP COLON SP LF + +Where is the path of a file being queried, is an attribute +being queried and can be either: + +'unspecified';; when the attribute is not defined for the path. +'unset';; when the attribute is defined to false. +'set';; when the attribute is defined to true. +;; when a value has been assigned to the attribute. + +EXAMPLES +-------- + +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 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 -------- -- tg: (6c16792..) jf/man-git-check-attr-output (depends on: maint) -- Jonas Fonseca