document that git-tag can tag more than heads
authorJonathan Nieder <jrnieder@uchicago.edu>
Thu, 24 Jul 2008 16:55:25 +0000 (11:55 -0500)
committerJunio C Hamano <gitster@pobox.com>
Fri, 25 Jul 2008 07:26:44 +0000 (00:26 -0700)
After looking the git-tag manpage, someone on #git wondered how
to tag a commit that is not a branch head.  This patch changes
the synopsis to say "<commit> | <object>" instead of "<head>" to
address his question.

Samuel Bronson had the idea of putting "<commit> | <object>"
for "<object>" because most tags point to commits (and for the
rest of the manpage, all tags point to commits).

Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-tag.txt

index b8dc88fa387b7274df5b80d248e3c4c9743cbc6a..046ab3542bab4048fe07c8a6718d63f9cd9e3791 100644 (file)
@@ -9,7 +9,8 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
 SYNOPSIS
 --------
 [verse]
-'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]  <name> [<head>]
+'git tag' [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>]
+       <name> [<commit> | <object>]
 'git tag' -d <name>...
 'git tag' [-n[<num>]] -l [<pattern>]
 'git tag' -v <name>...