# [PATCH] Documentation/git-tag.txt: Clarify tagging of objects

2 messages from 2008-03-24 to 2008-03-24. Participants: Pieter de Bie, Carlos Rica.
Thread: https://gitlist.dev/t/12842

## Pieter de Bie, 2008-03-24 15:11

Subject: [PATCH] Documentation/git-tag.txt: Clarify tagging of objects
Message-ID: <1206371505-7698-1-git-send-email-pdebie@ai.rug.nl>
URL: https://gitlist.dev/e/1206371505-7698-1-git-send-email-pdebie%40ai.rug.nl

```
Change the synopsis and description of git-tag to reflect that any
object can be tagged, not just a committish.
---
This surprised me, so I guess the documentation deserves some attention.
I'm only able to build the HTML documentation, so I hope this looks correct
in manpages too.

-  Pieter


 Documentation/git-tag.txt |   11 ++++++++---
 1 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index b62a3d1..9702f2f 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -9,7 +9,7 @@ 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> [<object>]
 'git-tag' -d <name>...
 'git-tag' [-n [<num>]] -l [<pattern>]
 'git-tag' -v <name>...
@@ -18,6 +18,11 @@ DESCRIPTION
 -----------
 Adds a 'tag' reference in `.git/refs/tags/`
 
+If `<object>` is given, the given object will be tagged. While
+this usually is a committish, other objects may be tagged
+as well. If `<object>` is not given, the current HEAD will be
+tagged.
+
 Unless `-f` is given, the tag must not yet exist in
 `.git/refs/tags/` directory.
 
@@ -26,8 +31,8 @@ creates a 'tag' object, and requires the tag message.  Unless
 `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
 in the tag message.
 
-Otherwise just the SHA1 object name of the commit object is
-written (i.e. a lightweight tag).
+Otherwise just the SHA1 object name of the object is written
+(i.e. a lightweight tag).
 
 A GnuPG signed tag object will be created when `-s` or `-u
 <key-id>` is used.  When `-u <key-id>` is not used, the
-- 
1.5.4.4.594.g91c25

```

## Carlos Rica, 2008-03-24 18:16

Subject: Re: [PATCH] Documentation/git-tag.txt: Clarify tagging of objects
Message-ID: <1b46aba20803241116k20072dc8wdb70e6de90ed25aa@mail.gmail.com>
URL: https://gitlist.dev/e/1b46aba20803241116k20072dc8wdb70e6de90ed25aa%40mail.gmail.com
In-Reply-To: <1206371505-7698-1-git-send-email-pdebie@ai.rug.nl>

```
On Mon, Mar 24, 2008 at 4:11 PM, Pieter de Bie <pdebie@ai.rug.nl> wrote:
>  -'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> [<object>]

Note that you need to change also the corresponding string inside
builtin-tag.c , the lines printed when you run "git tag -h".

--
Carlos

```