Michael J Gruber <git@xxxxxxxxxxxxxxxxxxxx> 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@xxxxxxxxxxxxxxxxxxxx>
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.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html