2005-10-17 07:41:59 +02:00
|
|
|
git-check-ref-format(1)
|
|
|
|
|
=======================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2006-03-09 17:24:50 +01:00
|
|
|
git-check-ref-format - Make sure ref name is well formed
|
2005-10-17 07:41:59 +02:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2009-03-21 22:19:53 +01:00
|
|
|
[verse]
|
2008-06-30 08:09:04 +02:00
|
|
|
'git check-ref-format' <refname>
|
2009-03-21 22:19:53 +01:00
|
|
|
'git check-ref-format' [--branch] <branchname-shorthand>
|
2005-10-17 07:41:59 +02:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
Checks if a given 'refname' is acceptable, and exits non-zero if
|
|
|
|
|
it is not.
|
|
|
|
|
|
|
|
|
|
A reference is used in git to specify branches and tags. A
|
|
|
|
|
branch head is stored under `$GIT_DIR/refs/heads` directory, and
|
|
|
|
|
a tag is stored under `$GIT_DIR/refs/tags` directory. git
|
|
|
|
|
imposes the following rules on how refs are named:
|
|
|
|
|
|
2006-06-07 14:56:45 +02:00
|
|
|
. It can include slash `/` for hierarchical (directory)
|
|
|
|
|
grouping, but no slash-separated component can begin with a
|
|
|
|
|
dot `.`;
|
2005-10-17 07:41:59 +02:00
|
|
|
|
|
|
|
|
. It cannot have two consecutive dots `..` anywhere;
|
|
|
|
|
|
|
|
|
|
. It cannot have ASCII control character (i.e. bytes whose
|
|
|
|
|
values are lower than \040, or \177 `DEL`), space, tilde `~`,
|
2005-12-16 03:03:59 +01:00
|
|
|
caret `{caret}`, colon `:`, question-mark `?`, asterisk `*`,
|
|
|
|
|
or open bracket `[` anywhere;
|
2005-10-17 07:41:59 +02:00
|
|
|
|
check_ref_format(): tighten refname rules
This changes the rules for refnames to forbid:
(1) a refname that contains "@{" in it.
Some people and foreign SCM converter may have named their branches
as frotz@24 and we still want to keep supporting it.
However, "git branch frotz@{24}" is a disaster. It cannot even
checked out because "git checkout frotz@{24}" will interpret it as
"detach the HEAD at twenty-fourth reflog entry of the frotz branch".
(2) a refname that ends with a dot.
We already reject a path component that begins with a dot, primarily
to avoid ambiguous range interpretation. If we allowed ".B" as a
valid ref, it is unclear if "A...B" means "in dot-B but not in A" or
"either in A or B but not in both".
But for this to be complete, we need also to forbid "A." to avoid "in
B but not in A-dot". This was not a problem in the original range
notation, but we should have added this restriction when three-dot
notation was introduced.
Unlike "no dot at the beginning of any path component" rule, this
rule does not have to be "no dot at the end of any path component",
because you cannot abbreviate the tail end away, similar to you can
say "dot-B" to mean "refs/heads/dot-B".
For these reasons, it is not likely people created branches with these
names on purpose, but we have allowed such names to be used for quite some
time, and it is possible that people created such branches by mistake or
by accident.
To help people with branches with such unfortunate names to recover,
we still allow "branch -d 'bad.'" to delete such branches, and also allow
"branch -m bad. good" to rename them.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-03-21 21:27:31 +01:00
|
|
|
. They cannot end with a slash `/` nor a dot `.`.
|
|
|
|
|
|
|
|
|
|
. They cannot contain a sequence `@{`.
|
2005-10-17 07:41:59 +02:00
|
|
|
|
|
|
|
|
These rules makes it easy for shell script based tools to parse
|
2005-12-16 03:03:59 +01:00
|
|
|
refnames, pathname expansion by the shell when a refname is used
|
|
|
|
|
unquoted (by mistake), and also avoids ambiguities in certain
|
2007-12-29 07:20:38 +01:00
|
|
|
refname expressions (see linkgit:git-rev-parse[1]). Namely:
|
2005-10-17 07:41:59 +02:00
|
|
|
|
|
|
|
|
. double-dot `..` are often used as in `ref1..ref2`, and in some
|
|
|
|
|
context this notation means `{caret}ref1 ref2` (i.e. not in
|
|
|
|
|
ref1 and in ref2).
|
|
|
|
|
|
|
|
|
|
. tilde `~` and caret `{caret}` are used to introduce postfix
|
|
|
|
|
'nth parent' and 'peel onion' operation.
|
|
|
|
|
|
|
|
|
|
. colon `:` is used as in `srcref:dstref` to mean "use srcref\'s
|
|
|
|
|
value and store it in dstref" in fetch and push operations.
|
2006-05-21 04:03:14 +02:00
|
|
|
It may also be used to select a specific object such as with
|
2008-07-03 07:41:41 +02:00
|
|
|
'git-cat-file': "git cat-file blob v1.3.3:refs.c".
|
2005-10-17 07:41:59 +02:00
|
|
|
|
check_ref_format(): tighten refname rules
This changes the rules for refnames to forbid:
(1) a refname that contains "@{" in it.
Some people and foreign SCM converter may have named their branches
as frotz@24 and we still want to keep supporting it.
However, "git branch frotz@{24}" is a disaster. It cannot even
checked out because "git checkout frotz@{24}" will interpret it as
"detach the HEAD at twenty-fourth reflog entry of the frotz branch".
(2) a refname that ends with a dot.
We already reject a path component that begins with a dot, primarily
to avoid ambiguous range interpretation. If we allowed ".B" as a
valid ref, it is unclear if "A...B" means "in dot-B but not in A" or
"either in A or B but not in both".
But for this to be complete, we need also to forbid "A." to avoid "in
B but not in A-dot". This was not a problem in the original range
notation, but we should have added this restriction when three-dot
notation was introduced.
Unlike "no dot at the beginning of any path component" rule, this
rule does not have to be "no dot at the end of any path component",
because you cannot abbreviate the tail end away, similar to you can
say "dot-B" to mean "refs/heads/dot-B".
For these reasons, it is not likely people created branches with these
names on purpose, but we have allowed such names to be used for quite some
time, and it is possible that people created such branches by mistake or
by accident.
To help people with branches with such unfortunate names to recover,
we still allow "branch -d 'bad.'" to delete such branches, and also allow
"branch -m bad. good" to rename them.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-03-21 21:27:31 +01:00
|
|
|
. at-open-brace `@{` is used as a notation to access a reflog entry.
|
|
|
|
|
|
2009-03-21 22:19:53 +01:00
|
|
|
With the `--branch` option, it expands a branch name shorthand and
|
|
|
|
|
prints the name of the branch the shorthand refers to.
|
|
|
|
|
|
|
|
|
|
EXAMPLE
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
git check-ref-format --branch @{-1}::
|
|
|
|
|
|
|
|
|
|
Print the name of the previous branch.
|
|
|
|
|
|
2005-10-17 07:41:59 +02:00
|
|
|
|
|
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 09:07:32 +02:00
|
|
|
Part of the linkgit:git[1] suite
|