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 <git@drmicha.warpmail.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael J Gruber committed
May 13, 2009 at 17:43 UTC
1a2872595409fbdd5d448730953884ef8d8c6613
1 file changed
+4
Documentation/git-check-ref-format.txt
+4
@@ -25,6 +25,10 @@ imposes the following rules on how references are named:
25
grouping, but no slash-separated component can begin with a
26
dot `.`.
27
28
+. They must contain at least one `/`. This enforces the presence of a
29
+ category like `heads/`, `tags/` etc. but the actual names are not
30
+ restricted.
31
+
32
. They cannot have two consecutive dots `..` anywhere.
33
34
. They cannot have ASCII control characters (i.e. bytes whose