undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation: consistently refer to check-ref-format

Browse Source 
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>
This commit is contained in:
Nanako Shiraishi 2009-08-22 09:45:18 +09:00 committed by Junio C Hamano
parent 2e1176d51e
commit b85e6c5f81
2 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/git-branch.txt
View File

@ -209,6 +209,12 @@ but different purposes:
- `--no-merged` is used to find branches which are candidates for merging - `--no-merged` is used to find branches which are candidates for merging
into HEAD, since those branches are not fully contained by HEAD. into HEAD, since those branches are not fully contained by HEAD.
SEE ALSO
--------
linkgit:git-check-ref-format[1],
linkgit:git-fetch[1],
linkgit:git-remote[1].
Author Author
------ ------
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com> Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <gitster@pobox.com>

20
Documentation/git-tag.txt
View File

@ -10,17 +10,15 @@ SYNOPSIS
-------- --------
[verse] [verse]
'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] 'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]
<name> [<commit> | <object>] <tagname> [<commit> | <object>]
'git tag' -d <name>... 'git tag' -d <tagname>...
'git tag' [-n[<num>]] -l [--contains <commit>] [<pattern>] 'git tag' [-n[<num>]] -l [--contains <commit>] [<pattern>]
'git tag' -v <name>... 'git tag' -v <tagname>...
DESCRIPTION DESCRIPTION
----------- -----------
Adds a 'tag' reference in `.git/refs/tags/`. The tag <name> must pass Adds a tag reference in `.git/refs/tags/`.
linkgit:git-check-ref-format[1] which basicly means that control characters,
space, ~, ^, :, ?, *, [ and \ are prohibited.
Unless `-f` is given, the tag must not yet exist in Unless `-f` is given, the tag must not yet exist in
`.git/refs/tags/` directory. `.git/refs/tags/` directory.
@ -88,6 +86,12 @@ OPTIONS
Implies `-a` if none of `-a`, `-s`, or `-u <key-id>` Implies `-a` if none of `-a`, `-s`, or `-u <key-id>`
is given. is given.
<tagname>::
The name of the tag to create, delete, or describe.
The new tag name must pass all checks defined by
linkgit:git-check-ref-format[1]. Some of these checks
may restrict the characters allowed in a tag name.
CONFIGURATION CONFIGURATION
------------- -------------
By default, 'git-tag' in sign-with-default mode (-s) will use your 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
------------ ------------
SEE ALSO
--------
linkgit:git-check-ref-format[1].
Author Author
------ ------
Written by Linus Torvalds <torvalds@osdl.org>, Written by Linus Torvalds <torvalds@osdl.org>,