path: root/Documentation/git-check-ref-format.txt
diff options
authorMichael J Gruber <>2009-05-13 15:43:06 (GMT)
committerJunio C Hamano <>2009-05-13 20:12:22 (GMT)
commit1a2872595409fbdd5d448730953884ef8d8c6613 (patch)
tree8ff8e857866f5863e566296010c36c4dc5e471ab /Documentation/git-check-ref-format.txt
parent00652369ff285f84e440f5d41d708283e30825d7 (diff)
Documentation: clarify / requirement in 'git check-ref-format'
'git check-ref-format' checks for the presence of at least one '/', the idea being that there should be no refs directly below 'refs/', so there should be a category like 'heads/' or 'tags/' in a refname. Try and make this clearer in the man page. Signed-off-by: Michael J Gruber <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-check-ref-format.txt')
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index c1ce268..0873e60 100644
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt
@@ -25,6 +25,10 @@ imposes the following rules on how references are named:
grouping, but no slash-separated component can begin with a
dot `.`.
+. They must contain at least one `/`. This enforces the presence of a
+ category like `heads/`, `tags/` etc. but the actual names are not
+ restricted.
. They cannot have two consecutive dots `..` anywhere.
. They cannot have ASCII control characters (i.e. bytes whose