check-ref-format doc: de-emphasize the implementation detail of a ref
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>
Junio C Hamano committed
Jun 23, 2011 at 09:31 UTC
a0a7e9e511faa86663148557d0f5b0597767d25a
1 file changed
+6
-3
Documentation/git-check-ref-format.txt
+6
-3
@@ -18,9 +18,12 @@ Checks if a given 'refname' is acceptable, and exits with a non-zero
18
status if it is not.
19
20
A reference is used in git to specify branches and tags. A
21
-branch head is stored under the `$GIT_DIR/refs/heads` directory, and
22
-a tag is stored under the `$GIT_DIR/refs/tags` directory (or, if refs
23
-are packed by `git gc`, as entries in the `$GIT_DIR/packed-refs` file).
21
+branch head is stored in the `refs/heads` hierarchy, while
22
+a tag is stored in the `refs/tags` hierarchy of the ref namespace
23
+(typically in `$GIT_DIR/refs/heads` and `$GIT_DIR/refs/tags`
24
+directories or, as entries in file `$GIT_DIR/packed-refs`
25
+if refs are packed by `git gc`).
26
+
27
git imposes the following rules on how references are named:
28
29
. They can include slash `/` for hierarchical (directory)