[PATCH] document that git-tag can tag more than heads

From: Jonathan Nieder <jrnieder@uchicago.edu>
Date: Jul 24, 2008, 05:01 UTC
Message-ID: <Pine.GSO.4.62.0807240000470.23113@harper.uchicago.edu>

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-ish> | <object>" instead of "<head>" to address his question.

Samuel Bronson had the idea of putting "<commit-ish> | <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>
---
 Documentation/git-tag.txt |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index b8dc88f..1ce1d7d 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -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-ish> | <object>]
 'git tag' -d <name>...
 'git tag' [-n[<num>]] -l [<pattern>]
 'git tag' -v <name>...

-- 
1.5.6.3.549.g8ca11