Code

check-ref-format doc: de-emphasize the implementation detail of a ref
authorJunio C Hamano <gitster@pobox.com>
Thu, 23 Jun 2011 16:31:19 +0000 (09:31 -0700)
committerJunio C Hamano <gitster@pobox.com>
Thu, 23 Jun 2011 22:38:14 +0000 (15:38 -0700)
It is an unimportant implementation detail that branches and tags are
stored somewhere under $GIT_DIR/refs directory. What is more important
is that branches live in refs/heads and tags live in refs/tags hierarchy
in the ref namespace.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-check-ref-format.txt

index 205d83dd0b281d59e0f53284d29846c8eb58a246..c9fdf84a08847bd8cb8c9ce1e2f50241975e267c 100644 (file)
@@ -18,9 +18,12 @@ Checks if a given 'refname' is acceptable, and exits with a non-zero
 status if it is not.
 
 A reference is used in git to specify branches and tags.  A
-branch head is stored under the `$GIT_DIR/refs/heads` directory, and
-a tag is stored under the `$GIT_DIR/refs/tags` directory (or, if refs
-are packed by `git gc`, as entries in the `$GIT_DIR/packed-refs` file).
+branch head is stored in the `refs/heads` hierarchy, while
+a tag is stored in the `refs/tags` hierarchy of the ref namespace
+(typically in `$GIT_DIR/refs/heads` and `$GIT_DIR/refs/tags`
+directories or, as entries in file `$GIT_DIR/packed-refs`
+if refs are packed by `git gc`).
+
 git imposes the following rules on how references are named:
 
 . They can include slash `/` for hierarchical (directory)