git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Pieter de Bie <pdebie@ai.rug.nl>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Pieter de Bie <pdebie@ai.rug.nl>
Subject: [PATCH] Documentation/git-tag.txt: Clarify tagging of objects
Date: Mon, 24 Mar 2008 16:11:45 +0100	[thread overview]
Message-ID: <1206371505-7698-1-git-send-email-pdebie@ai.rug.nl> (raw)

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

             reply	other threads:[~2008-03-24 15:12 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-03-24 15:11 Pieter de Bie [this message]
2008-03-24 18:16 ` [PATCH] Documentation/git-tag.txt: Clarify tagging of objects Carlos Rica

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1206371505-7698-1-git-send-email-pdebie@ai.rug.nl \
    --to=pdebie@ai.rug.nl \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).