Merge branch 'tr/merge-edit-guidance' into maint

[git.git] / Documentation / git-annotate.txt

diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt
index 8b6b56a54409dd586047a1a6cdf1138e8bb0e77b..05fd482b74ed00445613c7cc9b8a0b019ae31550 100644 (file)
--- a/Documentation/git-annotate.txt
+++ b/Documentation/git-annotate.txt
@@ -3,16 +3,22 @@ git-annotate(1)
 
 NAME
 ----
-git-annotate - Annotate file lines with commit info
+git-annotate - Annotate file lines with commit information
 
 SYNOPSIS
 --------
+[verse]
 '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
 -------
@@ -22,10 +28,6 @@ SEE ALSO
 --------
 linkgit:git-blame[1]
 
-AUTHOR
-------
-Written by Ryan Anderson <ryan@michonline.com>.
-
 GIT
 ---
 Part of the linkgit:git[1] suite