[PATCH] Documentation: clarify information about 'ident' attribute

Jan Krüger· Oct 30, 2008, 18:14 UTC · lore

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).

Signed-off-by: Jan Krüger <jk@jk.gs>
---
Confused me and a few other people on IRC the other day.

 Documentation/gitattributes.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

Show changes to Documentation/gitattributes.txt +3 −3

diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index 2694559..b39db6b 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -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.

-- 
1.6.0.3.523.g304d0.dirty

Junio C Hamano· Oct 30, 2008, 19:30 UTC · re: Jan Krüger · lore

Re: [PATCH] Documentation: clarify information about 'ident' attribute

"Jan Krüger" <jk@jk.gs> writes:

> 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).

patchDocumentation: clarify information about 'ident' attribute