Skip to content

Commit cd747dc

Browse files
dmellorgitster
authored andcommitted
Documentation: minor grammatical fix in git-check-ref-format.txt
Signed-off-by: David J. Mellor <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 3460a60 commit cd747dc

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

Documentation/git-check-ref-format.txt

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,48 +3,48 @@ git-check-ref-format(1)
33

44
NAME
55
----
6-
git-check-ref-format - Make sure ref name is well formed
6+
git-check-ref-format - Ensures that a reference name is well formed
77

88
SYNOPSIS
99
--------
1010
'git check-ref-format' <refname>
1111

1212
DESCRIPTION
1313
-----------
14-
Checks if a given 'refname' is acceptable, and exits non-zero if
15-
it is not.
14+
Checks if a given 'refname' is acceptable, and exits with a non-zero
15+
status if it is not.
1616

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

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

26-
. It cannot have two consecutive dots `..` anywhere;
26+
. They cannot have two consecutive dots `..` anywhere.
2727

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

33-
. It cannot end with a slash `/`.
33+
. They cannot end with a slash `/`.
3434

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

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

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

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

0 commit comments

Comments
 (0)