Skip to content

Commit b85e6c5

Browse files
Nanako Shiraishigitster
authored andcommitted
Documentation: consistently refer to check-ref-format
Change the <name> placeholder to <tagname> in the SYNOPSIS section of git-tag documentation, and describe it in the OPTIONS section in a way similar to how documentation for git-branch does. Add SEE ALSO section to list the other documentation pages these two pages refer to. Signed-off-by: Nanako Shiraishi <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 2e1176d commit b85e6c5

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

Documentation/git-branch.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,12 @@ but different purposes:
209209
- `--no-merged` is used to find branches which are candidates for merging
210210
into HEAD, since those branches are not fully contained by HEAD.
211211

212+
SEE ALSO
213+
--------
214+
linkgit:git-check-ref-format[1],
215+
linkgit:git-fetch[1],
216+
linkgit:git-remote[1].
217+
212218
Author
213219
------
214220
Written by Linus Torvalds <[email protected]> and Junio C Hamano <[email protected]>

Documentation/git-tag.txt

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,15 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]
13-
<name> [<commit> | <object>]
14-
'git tag' -d <name>...
13+
<tagname> [<commit> | <object>]
14+
'git tag' -d <tagname>...
1515
'git tag' [-n[<num>]] -l [--contains <commit>] [<pattern>]
16-
'git tag' -v <name>...
16+
'git tag' -v <tagname>...
1717

1818
DESCRIPTION
1919
-----------
2020

21-
Adds a 'tag' reference in `.git/refs/tags/`. The tag <name> must pass
22-
linkgit:git-check-ref-format[1] which basicly means that control characters,
23-
space, ~, ^, :, ?, *, [ and \ are prohibited.
21+
Adds a tag reference in `.git/refs/tags/`.
2422

2523
Unless `-f` is given, the tag must not yet exist in
2624
`.git/refs/tags/` directory.
@@ -88,6 +86,12 @@ OPTIONS
8886
Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
8987
is given.
9088

89+
<tagname>::
90+
The name of the tag to create, delete, or describe.
91+
The new tag name must pass all checks defined by
92+
linkgit:git-check-ref-format[1]. Some of these checks
93+
may restrict the characters allowed in a tag name.
94+
9195
CONFIGURATION
9296
-------------
9397
By default, 'git-tag' in sign-with-default mode (-s) will use your
@@ -252,6 +256,10 @@ $ GIT_COMMITTER_DATE="2006-10-02 10:31" git tag -s v1.0.1
252256
------------
253257

254258

259+
SEE ALSO
260+
--------
261+
linkgit:git-check-ref-format[1].
262+
255263
Author
256264
------
257265
Written by Linus Torvalds <[email protected]>,

0 commit comments

Comments
 (0)