From: Bagas Sanjaya <bagasdotme@gmail.com>
Date: Fri, 1 Oct 2021 11:37:25 +0000 (+0700)
Subject: blame: describe default output format
X-Git-Url: https://www.git.kevux.org/?a=commitdiff_plain;h=38c356aad6c9805ce766e44067c18a1894eb7d62;p=rit

blame: describe default output format

While there is descriptions for porcelain and incremental output
formats, the default format isn't described. Describe that format for
the sake of completeness.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
index 34b496d485..2406790ebf 100644
--- a/Documentation/git-blame.txt
+++ b/Documentation/git-blame.txt
@@ -93,6 +93,19 @@ include::blame-options.txt[]
 	is used for a caret to mark the boundary commit.
 
 
+THE DEFAULT FORMAT
+------------------
+
+When neither `--porcelain` nor `--incremental` option is specified,
+`git blame` will output annotation for each line with:
+
+- abbreviated object name for the commit the line came from;
+- author ident (by default author name and date, unless `-s` or `-e`
+  is specified); and
+- line number
+
+before the line contents.
+
 THE PORCELAIN FORMAT
 --------------------