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 <nanako3@lavabit.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Nanako Shiraishi committed
Aug 22, 2009 at 09:45 UTC
b85e6c5f8107c802c627981e044e680999884c5f
2 files changed
+20
-6
Documentation/git-branch.txt
+6
@@ -209,6 +209,12 @@ but different purposes:
209
- `--no-merged` is used to find branches which are candidates for merging
210
into HEAD, since those branches are not fully contained by HEAD.
211
212
+SEE ALSO
213
+--------
214
+linkgit:git-check-ref-format[1],
215
+linkgit:git-fetch[1],
216
+linkgit:git-remote[1].
217
+
218
Author
219
------
220
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com>
Documentation/git-tag.txt
+14
-6
@@ -10,17 +10,15 @@ SYNOPSIS
10
--------
11
[verse]
12
'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>...
15
'git tag' [-n[<num>]] -l [--contains <commit>] [<pattern>]
16
-'git tag' -v <name>...
16
+'git tag' -v <tagname>...
17
18
DESCRIPTION
19
-----------
20
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/`.
22
23
Unless `-f` is given, the tag must not yet exist in
24
`.git/refs/tags/` directory.
@@ -88,6 +86,12 @@ OPTIONS
86
Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
87
is given.
88
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
+
95
CONFIGURATION
96
-------------
97
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
256
------------
257
258
259
+SEE ALSO
260
+--------
261
+linkgit:git-check-ref-format[1].
262
+
263
Author
264
------
265
Written by Linus Torvalds <torvalds@osdl.org>,