completion: Use consistent if [...] convention, not "test"
[gitweb.git] / Documentation / git-annotate.txt
index da15379ae53046b2c6384e505c9e28595171fa66..0aba022ba6838442721a0584f3eaa293a3a90f74 100644 (file)
@@ -7,13 +7,18 @@ 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[]