Merge branch 'jc/maint-add-u-remove-conflicted'
[gitweb.git] / Documentation / git-annotate.txt
index 02dc4740d0a5f129d46c116eb9aabeec85af02fa..0aba022ba6838442721a0584f3eaa293a3a90f74 100644 (file)
@@ -7,20 +7,25 @@ git-annotate - Annotate file lines with commit info
 
 SYNOPSIS
 --------
-git-annotate [options] file [revision]
+'git annotate' [options] file [revision]
 
 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 between this command and linkgit:git-blame[1] is that
+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[]
 
 SEE ALSO
 --------
-gitlink:git-blame[1]
+linkgit:git-blame[1]
 
 AUTHOR
 ------
@@ -28,4 +33,4 @@ Written by Ryan Anderson <ryan@michonline.com>.
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[1] suite