user-manual: remote-tracking can be checked out, with detached HEAD
[gitweb.git] / Documentation / git-annotate.txt
index 45a6a7251ea7acc88e3036402e11a787a7880d66..0590eec0566cf9f318ddd1ac27d10bb989b2c52f 100644 (file)
@@ -3,16 +3,21 @@ git-annotate(1)
 
 NAME
 ----
-git-annotate - Annotate file lines with commit info
+git-annotate - Annotate file lines with commit information
 
 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.
+which introduced the line. Optionally annotates 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 a more
+familiar command name for people coming from other SCM systems.
 
 OPTIONS
 -------
@@ -28,4 +33,4 @@ Written by Ryan Anderson <ryan@michonline.com>.
 
 GIT
 ---
-Part of the linkgit:git[7] suite
+Part of the linkgit:git[1] suite