[PATCH] Improve and fix git-check-attr(1)
- From
Jonas Fonseca <fonseca@diku.dk>
- Date
- Oct 13, 2008, 17:57 UTC
- Message-ID
- <20081013175705.GA9538@diku.dk>
Always use 'verse' for multi-line synopsis sections. Add output and example sections to document what output can be expected.
Signed-off-by: Jonas Fonseca <fonseca@diku.dk>
--- Documentation/git-check-attr.txt | 63 +++++++++++++++++++++++++++++++++++++- 1 files changed, 62 insertions(+), 1 deletions(-)
At least the first chunk should be applied. The last is a quick attempt at documenting the expected output formally and with examples.
diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt index 14e4374..09c5234 100644 --- a/Documentation/git-check-attr.txt +++ b/Documentation/git-check-attr.txt @@ -8,8 +8,9 @@ git-check-attr - Display gitattributes information. SYNOPSIS -------- +[verse] 'git check-attr' attr... [--] pathname... -'git check-attr' --stdin [-z] attr... < <list-of-paths +'git check-attr' --stdin [-z] attr... < <list-of-paths> DESCRIPTION ----------- @@ -30,6 +31,66 @@ 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: +<path> COLON SP <attribute> COLON SP <info> LF + +Where <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 to false. +'set';; when the attribute is defined to true. +<value>;; when a value has been assigned to the attribute. + +EXAMPLES +-------- + +In the following examples, the following '.gitattributes' file is used: +--------------- +*.java diff=java -crlf myAttr +README caveat=unspecified +--------------- + +* Output for an unspecified attribute: +--------------- +$ git check-attr filter src/org/example/lib/MyClass.java +src/org/example/lib/MyClass.java: filter: unspecified +--------------- + +* Output for an unset attribute: +--------------- +$ git check-attr crlf src/org/example/lib/MyClass.java +src/org/example/lib/MyClass.java: crlf: unset +--------------- + +* Output for an attribute that has been set: +--------------- +$ git check-attr myAttr src/org/example/lib/MyClass.java +src/org/example/lib/MyClass.java: myAttr: set +--------------- + +* Output for an attribute set to a value: +--------------- +$ git check-attr diff src/org/example/lib/MyClass.java +src/org/example/lib/MyClass.java: diff: java +--------------- + +* Listing multiple attributes for a file: +--------------- +$ git check-attr crlf diff myAttr -- src/org/example/lib/MyClass.java +src/org/example/lib/MyClass.java: crlf: unset +src/org/example/lib/MyClass.java: diff: java +src/org/example/lib/MyClass.java: myAttr: set +--------------- + +* Not all values are equally unambiguous: +--------------- +$ git check-attr caveat README +src/org/example/lib/MyClass.java: caveat: unspecified +--------------- SEE ALSO --------
-- tg: (340fcf4..) jf/man-git-check-attr (depends on: next) -- Jonas Fonseca