Re: [PATCH] Mention the fact that 'git annotate' is only for backward compatibility.

From: Petr Baudis <pasky@suse.cz>
Date: Sep 5, 2008, 08:07 UTC
Message-ID: <20080905080759.GN10360@machine.or.cz>
In-Reply-To: <7v3akfxd74.fsf@gitster.siamese.dyndns.org>

On Fri, Sep 05, 2008 at 12:29:51AM -0700, Junio C Hamano wrote:

Show 9 quoted lines

> diff --git c/Documentation/git-annotate.txt w/Documentation/git-annotate.txt
> index 8b6b56a..78dc5e2 100644
> --- c/Documentation/git-annotate.txt
> +++ w/Documentation/git-annotate.txt
> @@ -14,6 +14,11 @@ DESCRIPTION
>  Annotates each line in the given file with information from the commit
>  which introduced the line. Optionally annotate from a given revision.
>  
> +The only difference from this command and linkgit:git-blame[1] is that

                       ^^^^ between?

Show 7 quoted lines

> +they use slightly different output formats, and this command exists only
> +for backward compatibility to support existing scripts, and provide more
> +familiar command name for people coming from other SCM systems.
> +
>  OPTIONS
>  -------
>  include::blame-options.txt[]

I like this one. I'm still not too happy about leaving the command in the command list and tab completion since I believe reducing the number of commands (which is still quite intimidating for the user), even just by a little, is more important than encouraging people to use compatibility aliases. I don't feel very strongly about it, though.

Acked-by: Petr Baudis <pasky@suse.cz>