git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Michael J Gruber <git@drmicha.warpmail.net>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 7/7] git-tag.txt: list all modes in the description
Date: Mon, 14 Feb 2011 12:03:06 -0800	[thread overview]
Message-ID: <7v8vxis7t1.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <496c871d087c0677ddd3374d432e56c891375025.1297695910.git.git@drmicha.warpmail.net> (Michael J. Gruber's message of "Mon\, 14 Feb 2011 16\:10\:35 +0100")

Michael J Gruber <git@drmicha.warpmail.net> writes:

> 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 and qualifying the main part.
>
> Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>

Thanks for noticing; I agree with the basic idea.

> diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
> index 8b169e3..c503f60 100644
> --- a/Documentation/git-tag.txt
> +++ b/Documentation/git-tag.txt
> @@ -18,7 +18,7 @@ SYNOPSIS
> ...
> -Adds a tag reference in `.git/refs/tags/`.
> +Without `-d/-l/-v`: Adds a tag reference in `.git/refs/tags/`.

But this leaves the reader in suspense what these three exceptions are for
after finishing the first sentence.  How about rewording like this?

    Add a tag reference in `.git/refs/tags/`, unless `-d/-l/-v` is given
    to delete, list or verify.

Then we don't need to repeat these three

    With `-d`: Deletes a tag.

    With `-l`: List tags.

    With `-v`: Verify tags.

that the readers would see in OPTIONS section fairly soon.

  reply	other threads:[~2011-02-14 20:03 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 [this message]
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   ` [PATCHv2 07/10] git-tag.txt: list all modes in the description Michael J Gruber
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=7v8vxis7t1.fsf@alter.siamese.dyndns.org \
    --to=gitster@pobox.com \
    --cc=git@drmicha.warpmail.net \
    --cc=git@vger.kernel.org \
    /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).