[PATCH 1/5] check-ref-format doc: de-emphasize the implementation detail of a ref
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:51:31
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
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 <redacted> --- Documentation/git-check-ref-format.txt | 9 ++++++--- 1 files changed, 6 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index 205d83d..61471cf 100644
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt@@ -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 +(which are found in `$GIT_DIR/refs/heads` and `$GIT_DIR/refs/tags` +directories or, if refs are packed by `git gc`, as entries in +the `$GIT_DIR/packed-refs` file). + git imposes the following rules on how references are named: . They can include slash `/` for hierarchical (directory)
--
1.7.6.rc3