Merge branch 'jc/maint-refs-dangling' into maint
[gitweb.git] / Documentation / git-check-ref-format.txt
index d9a3326f58c0324b6e32fb130325213a413d35ab..379eee6734323ee566480d5f9159dd28ed27ecd2 100644 (file)
@@ -19,8 +19,9 @@ 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.  git
-imposes the following rules on how references are named:
+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).
+git imposes the following rules on how references are named:
 
 . They can include slash `/` for hierarchical (directory)
   grouping, but no slash-separated component can begin with a
@@ -43,7 +44,7 @@ imposes the following rules on how references are named:
 
 . They cannot contain a sequence `@{`.
 
-- They cannot contain a `\\`.
+. They cannot contain a `\`.
 
 These rules make it easy for shell script based tools to parse
 reference names, pathname expansion by the shell when a reference name is used