git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: git@vger.kernel.org
Subject: [PATCH 2/5] git.txt: de-emphasize the implementation detail of a ref
Date: Thu, 23 Jun 2011 09:52:35 -0700	[thread overview]
Message-ID: <1308847958-3429-3-git-send-email-gitster@pobox.com> (raw)
In-Reply-To: <1308847958-3429-1-git-send-email-gitster@pobox.com>

It is an unimportant implementation detail that branches and tags are
stored somewhere under $GIT_DIR/refs directory, or the name of the commit
that will become the parent of the next commit is stored in $GIT_DIR/HEAD.

What is more important is that branches live in refs/heads and tags live
in refs/tags hierarchy in the ref namespace, and HEAD means the tip of the
current branch.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git.txt |    7 +++----
 1 files changed, 3 insertions(+), 4 deletions(-)

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 8c0bfdf..7fc6b88 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -510,16 +510,15 @@ Any git command accepting any <object> can also use the following
 symbolic notation:
 
 HEAD::
-	indicates the head of the current branch (i.e. the
-	contents of `$GIT_DIR/HEAD`).
+	indicates the head of the current branch.
 
 <tag>::
 	a valid tag 'name'
-	(i.e. the contents of `$GIT_DIR/refs/tags/<tag>`).
+	(i.e. a `refs/tags/<tag>` reference).
 
 <head>::
 	a valid head 'name'
-	(i.e. the contents of `$GIT_DIR/refs/heads/<head>`).
+	(i.e. a `refs/heads/<head>` reference).
 
 For a more complete list of ways to spell object names, see
 "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
-- 
1.7.6.rc3

  parent reply	other threads:[~2011-06-23 16:52 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-06-23  4:45 [PATCH] git-remote.txt: fix wrong remote refspec Namhyung Kim
2011-06-23  5:35 ` Junio C Hamano
2011-06-23  6:17   ` Namhyung Kim
2011-06-23  8:12     ` [PATCH v2] " Namhyung Kim
2011-06-23 15:33   ` [PATCH] " Junio C Hamano
2011-06-23 16:03     ` Namhyung Kim
2011-06-23 16:52     ` [PATCH 0/5] Clarify "refs" Junio C Hamano
2011-06-23 16:52       ` [PATCH 1/5] check-ref-format doc: de-emphasize the implementation detail of a ref Junio C Hamano
2011-06-23 22:14         ` Eric Sunshine
2011-06-23 16:52       ` Junio C Hamano [this message]
2011-06-23 16:52       ` [PATCH 3/5] glossary: update description of "tag" Junio C Hamano
2011-06-23 22:19         ` Eric Sunshine
2011-06-23 16:52       ` [PATCH 4/5] glossary: update description of head and ref Junio C Hamano
2011-06-23 16:52       ` [PATCH 5/5] glossary: clarify description of HEAD Junio C Hamano
2011-06-23 17:06         ` Carlos Martín Nieto
2011-06-23 17:12           ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1308847958-3429-3-git-send-email-gitster@pobox.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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 NNTP newsgroup(s).