diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2011-06-23 09:31:19 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2011-06-23 15:38:14 -0700 |
| commit | a0a7e9e511faa86663148557d0f5b0597767d25a (patch) | |
| tree | 4d5897941a38ec6b16a39c94aa5d569a51c8bd00 /Documentation/git-check-ref-format.txt | |
| parent | git-remote.txt: avoid sounding as if loose refs are the only ones in the world (diff) | |
| download | tgif-a0a7e9e511faa86663148557d0f5b0597767d25a.tar.xz | |
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>
Diffstat (limited to 'Documentation/git-check-ref-format.txt')
| -rw-r--r-- | 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 205d83dd0b..c9fdf84a08 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 +(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) |