diff options
author | Michael J Gruber <git@drmicha.warpmail.net> | 2009-05-13 15:43:06 (GMT) |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2009-05-13 20:12:22 (GMT) |
commit | 1a2872595409fbdd5d448730953884ef8d8c6613 (patch) | |
tree | 8ff8e857866f5863e566296010c36c4dc5e471ab /Documentation/git-check-ref-format.txt | |
parent | 00652369ff285f84e440f5d41d708283e30825d7 (diff) | |
download | git-1a2872595409fbdd5d448730953884ef8d8c6613.zip git-1a2872595409fbdd5d448730953884ef8d8c6613.tar.gz git-1a2872595409fbdd5d448730953884ef8d8c6613.tar.bz2 |
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>
Diffstat (limited to 'Documentation/git-check-ref-format.txt')
-rw-r--r-- | Documentation/git-check-ref-format.txt | 4 |
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 |