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

Petr Baudis [off-list ref] writes:

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

quoted

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?

quoted

+they use slightly different output formats, and this command exists only

I'm not sure it's clear enough that "this command" is "annotate" since
you talked about git blame right before, but I'm being picky.

quoted

+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.

Meetoo.

-- 
Matthieu