Merge branch 'jc/t9129-any-utf8' into maint

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

diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt
index 7baf73111bc6e4fa7668f8aec31b95f20698a6ae..0590eec0566cf9f318ddd1ac27d10bb989b2c52f 100644 (file)
--- a/Documentation/git-annotate.txt
+++ b/Documentation/git-annotate.txt
@@ -3,37 +3,29 @@ 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
 -------
--l, --long::
-       Show long rev (Defaults off).
-
--t, --time::
-       Show raw timestamp (Defaults off).
-
--r, --rename::
-       Follow renames (Defaults on).
-
--S, --rev-file <revs-file>::
-       Use revs from revs-file instead of calling git-rev-list.
-
--h, --help::
-       Show help message.
+include::blame-options.txt[]
 
 SEE ALSO
 --------
-gitlink:git-blame[1]
+linkgit:git-blame[1]
 
 AUTHOR
 ------
@@ -41,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