git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Michael J Gruber <git@drmicha.warpmail.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>,
	Johannes Sixt <j6t@kdbg.org>,
	Sverre Rabbelier <srabbelier@gmail.com>
Subject: [PATCHv2 07/10] git-tag.txt: list all modes in the description
Date: Tue, 15 Feb 2011 14:09:10 +0100	[thread overview]
Message-ID: <d40d37a59ce17ff833edf07fd20f0faebde319a3.1297775122.git.git@drmicha.warpmail.net> (raw)
In-Reply-To: <cover.1297695910.git.git@drmicha.warpmail.net>
In-Reply-To: <cover.1297775122.git.git@drmicha.warpmail.net>

Currently, the description sounds as if it applied always, but most of
its content is true in "create tag mode" only.

Make this clearer by listing all modes upfront.

Also, sneak in some linguistic improvements and make it clearer that
lightweight tags are "created" because "written" may be misread as
"are output".

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
 Documentation/git-tag.txt |   11 ++++++-----
 1 files changed, 6 insertions(+), 5 deletions(-)

diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 8b169e3..65f76c5 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -18,21 +18,22 @@ SYNOPSIS
 DESCRIPTION
 -----------
 
-Adds a tag reference in `.git/refs/tags/`.
+Add a tag reference in `.git/refs/tags/`, unless `-d/-l/-v` is given
+to delete, list or verify tags.
 
-Unless `-f` is given, the tag must not yet exist in
+Unless `-f` is given, the tag to be created must not yet exist in the
 `.git/refs/tags/` directory.
 
 If one of `-a`, `-s`, or `-u <key-id>` is passed, the command
-creates a 'tag' object, and requires the tag message.  Unless
+creates a 'tag' object, and requires a tag message.  Unless
 `-m <msg>` or `-F <file>` is given, an editor is started for the user to type
 in the tag message.
 
 If `-m <msg>` or `-F <file>` is given and `-a`, `-s`, and `-u <key-id>`
 are absent, `-a` is implied.
 
-Otherwise just the SHA1 object name of the commit object is
-written (i.e. a lightweight tag).
+Otherwise just a tag reference for the SHA1 object name of the commit object is
+created (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.7.4.1.74.gf39475.dirty

  parent reply	other threads:[~2011-02-15 13:12 UTC|newest]

Thread overview: 36+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-02-14 15:10 [PATCH 0/7] Cleaning up --help-all inconsistencies Michael J Gruber
2011-02-14 15:10 ` [PATCH 1/7] commit,tag: use same wording for -F Michael J Gruber
2011-02-14 19:49   ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 2/7] push: describe --porcelain just like commit and status Michael J Gruber
2011-02-14 19:42   ` Johannes Sixt
2011-02-14 19:53   ` Junio C Hamano
2011-02-14 22:25     ` Sverre Rabbelier
2011-02-15  6:50     ` Michael J Gruber
2011-02-14 15:10 ` [PATCH 3/7] clone,init: describe --template using the same wording Michael J Gruber
2011-02-14 19:54   ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 4/7] merge,tag: describe -m just like commit Michael J Gruber
2011-02-14 20:08   ` Junio C Hamano
2011-02-15  7:08     ` Michael J Gruber
2011-02-15 18:14       ` Junio C Hamano
2011-02-14 15:10 ` [PATCH 5/7] add: describe --patch like checkout, reset Michael J Gruber
2011-02-14 15:10 ` [PATCH 6/7] commit,status: describe -u likewise Michael J Gruber
2011-02-14 19:57   ` Junio C Hamano
2011-02-15  6:53     ` Michael J Gruber
2011-02-15  7:21       ` Jeff King
2011-02-14 15:10 ` [PATCH 7/7] git-tag.txt: list all modes in the description Michael J Gruber
2011-02-14 20:03   ` Junio C Hamano
2011-02-15 13:09 ` [PATCHv2 00/10] Cleaning up --help-all inconsistencies Michael J Gruber
2011-02-15 19:02   ` Junio C Hamano
2011-02-16  7:46     ` Michael J Gruber
2011-02-16 21:34       ` Junio C Hamano
2011-02-17  7:48         ` [PATCH] Make <identifier> lowercase in Documentation Michael J Gruber
     [not found] ` <cover.1297775122.git.git@drmicha.warpmail.net>
2011-02-15 13:09   ` [PATCHv2 01/10] commit,tag: use same wording for -F Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 02/10] commit,status: describe --porcelain just like push Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 03/10] clone,init: describe --template using the same wording Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 04/10] commit,merge,tag: describe -m likewise Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 05/10] add: describe --patch like checkout, reset Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 06/10] commit,status: describe -u likewise Michael J Gruber
2011-02-15 13:09   ` Michael J Gruber [this message]
2011-02-15 13:09   ` [PATCHv2 08/10] Make <identifier> lowercase as per CodingGuidelines Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 09/10] " Michael J Gruber
2011-02-15 13:09   ` [PATCHv2 10/10] " Michael J Gruber

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

  List information: http://vger.kernel.org/majordomo-info.html

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

  git send-email \
    --in-reply-to=d40d37a59ce17ff833edf07fd20f0faebde319a3.1297775122.git.git@drmicha.warpmail.net \
    --to=git@drmicha.warpmail.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=j6t@kdbg.org \
    --cc=peff@peff.net \
    --cc=srabbelier@gmail.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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).