git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH] Documentation: clarify information about 'ident' attribute
@ 2008-10-30 18:14 Jan Krüger
  2008-10-30 19:30 ` Junio C Hamano
  0 siblings, 1 reply; 2+ messages in thread
From: Jan Krüger @ 2008-10-30 18:14 UTC (permalink / raw
  To: git; +Cc: gitster

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

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

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] Documentation: clarify information about 'ident' attribute
  2008-10-30 18:14 [PATCH] Documentation: clarify information about 'ident' attribute Jan Krüger
@ 2008-10-30 19:30 ` Junio C Hamano
  0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2008-10-30 19:30 UTC (permalink / raw
  To: Jan Krüger; +Cc: git, gitster

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2008-10-30 19:32 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-10-30 18:14 [PATCH] Documentation: clarify information about 'ident' attribute Jan Krüger
2008-10-30 19:30 ` Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).