kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Documentation: minor grammatical fix in git-check-ref-format.txt 

Signed-off-by: David J. Mellor <dmellor@whistlingcat.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
David J. Mellor 2009-03-22 18:00:17 -07:00 committed by Junio C Hamano
parent 3460a60064
commit cd747dc6dc
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
Documentation/git-check-ref-format.txt
View File

@ -3,7 +3,7 @@ git-check-ref-format(1)


NAME NAME
---- ----
git-check-ref-format - Make sure ref name is well formed git-check-ref-format - Ensures that a reference name is well formed


SYNOPSIS SYNOPSIS
-------- --------
@ -11,40 +11,40 @@ SYNOPSIS


DESCRIPTION DESCRIPTION
----------- -----------
Checks if a given 'refname' is acceptable, and exits non-zero if Checks if a given 'refname' is acceptable, and exits with a non-zero
it is not. status if it is not.


A reference is used in git to specify branches and tags. A A reference is used in git to specify branches and tags. A
branch head is stored under `$GIT_DIR/refs/heads` directory, and branch head is stored under the `$GIT_DIR/refs/heads` directory, and
a tag is stored under `$GIT_DIR/refs/tags` directory. git a tag is stored under the `$GIT_DIR/refs/tags` directory. git
imposes the following rules on how refs are named: imposes the following rules on how references are named:


. It can include slash `/` for hierarchical (directory) . They can include slash `/` for hierarchical (directory)
grouping, but no slash-separated component can begin with a grouping, but no slash-separated component can begin with a
dot `.`; dot `.`.


. It cannot have two consecutive dots `..` anywhere; . They cannot have two consecutive dots `..` anywhere.


. It cannot have ASCII control character (i.e. bytes whose . They cannot have ASCII control characters (i.e. bytes whose
values are lower than \040, or \177 `DEL`), space, tilde `~`, values are lower than \040, or \177 `DEL`), space, tilde `~`,
caret `{caret}`, colon `:`, question-mark `?`, asterisk `*`, caret `{caret}`, colon `:`, question-mark `?`, asterisk `*`,
or open bracket `[` anywhere; or open bracket `[` anywhere.


. It cannot end with a slash `/`. . They cannot end with a slash `/`.


These rules makes it easy for shell script based tools to parse These rules make it easy for shell script based tools to parse
refnames, pathname expansion by the shell when a refname is used reference names, pathname expansion by the shell when a reference name is used
unquoted (by mistake), and also avoids ambiguities in certain unquoted (by mistake), and also avoids ambiguities in certain
refname expressions (see linkgit:git-rev-parse[1]). Namely: reference name expressions (see linkgit:git-rev-parse[1]):


. double-dot `..` are often used as in `ref1..ref2`, and in some . A double-dot `..` is often used as in `ref1..ref2`, and in some
context this notation means `{caret}ref1 ref2` (i.e. not in contexts this notation means `{caret}ref1 ref2` (i.e. not in
ref1 and in ref2). `ref1` and in `ref2`).


. tilde `~` and caret `{caret}` are used to introduce postfix . A tilde `~` and caret `{caret}` are used to introduce the postfix
'nth parent' and 'peel onion' operation. 'nth parent' and 'peel onion' operation.


. colon `:` is used as in `srcref:dstref` to mean "use srcref\'s . A colon `:` is used as in `srcref:dstref` to mean "use srcref\'s
value and store it in dstref" in fetch and push operations. value and store it in dstref" in fetch and push operations.
It may also be used to select a specific object such as with It may also be used to select a specific object such as with
'git-cat-file': "git cat-file blob v1.3.3:refs.c". 'git-cat-file': "git cat-file blob v1.3.3:refs.c".