Documentation: clarify information about 'ident' attribute
PATCH 1/1 Documentation: clarify information about 'ident' attribute
The documentation spoke of the attribute being set "to" a path; this can mistakenly be interpreted as "the attribute needs to have its value set to some kind of path". This clarifies things (and also calls the object ID a hash rather than a name because that might be confusing too).
---
Confused me and a few other people on IRC the other day.
Documentation/gitattributes.txt | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-)
Documentation/gitattributes.txt +3 -3
@@ -163,9 +163,9 @@ few exceptions. Even though... `ident` ^^^^^^^ -When the attribute `ident` is set to a path, git replaces -`$Id$` in the blob object with `$Id:`, followed by -40-character hexadecimal blob object name, followed by a dollar +When the attribute `ident` is set for a path, git replaces +`$Id$` in the blob object with `$Id:`, followed by the +40-character hexadecimal blob object hash, followed by a dollar sign `$` upon checkout. Any byte sequence that begins with `$Id:` and ends with `$` in the worktree file is replaced with `$Id$` upon check-in.
Signature · 1 line
1.6.0.3.523.g304d0.dirty
Quoted 4 lines · Jan Krüger
The documentation spoke of the attribute being set "to" a path; this can mistakenly be interpreted as "the attribute needs to have its value set to some kind of path". This clarifies things (and also calls the object ID a hash rather than a name because that might be confusing too).
I'd agree with the first change, but not with the second. "object name" has been the official name of these hexadecimal thingy for a long time (see the glossary).