From: Junio C Hamano <junkio@cox.net>
To: git@vger.kernel.org
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Subject: [PATCH] document 'blame --incremental'
Date: Sun, 28 Jan 2007 12:20:37 -0800 [thread overview]
Message-ID: <7v8xfmewdm.fsf_-_@assigned-by-dhcp.cox.net> (raw)
In-Reply-To: <Pine.LNX.4.64.0701281143190.25027@woody.linux-foundation.org> (Linus Torvalds's message of "Sun, 28 Jan 2007 11:57:33 -0800 (PST)")
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
index 5dd8e36..a4e4bee 100644
--- a/Documentation/git-blame.txt
+++ b/Documentation/git-blame.txt
@@ -8,7 +8,7 @@ git-blame - Show what revision and author last modified each line of a file
SYNOPSIS
--------
[verse]
-'git-blame' [-c] [-l] [-t] [-f] [-n] [-p] [-L n,m] [-S <revs-file>]
+'git-blame' [-c] [-l] [-t] [-f] [-n] [-p] [--incremental] [-L n,m] [-S <revs-file>]
[-M] [-C] [-C] [--since=<date>] [<rev>] [--] <file>
DESCRIPTION
@@ -63,6 +63,10 @@ OPTIONS
-p, --porcelain::
Show in a format designed for machine consumption.
+--incremental::
+ Show the result incrementally in a format designed for
+ machine consumption.
+
-M::
Detect moving lines in the file as well. When a commit
moves a block of lines in a file (e.g. the original file
@@ -158,6 +162,46 @@ parents, using `commit{caret}!` notation:
git blame -C -C -f $commit^! -- foo
+INCREMENTAL OUTPUT
+------------------
+
+When called with `--incremental` option, the command outputs the
+result as it is built. The output generally will talk about
+lines touched by more recent commits first and is meant to be
+used by interactive viewers.
+
+The output format is similar to the Porcelain format, but it
+does not contain the actual lines from the file that is being
+annotated.
+
+. Each blame entry always starts with a line of:
+
+ <40-byte hex sha1> <sourceline> <resultline> <num_lines>
++
+Line numbers count from 1.
+
+. The first time that commit shows up in the stream, it has various
+ other information about it printed out with a one-word tag at the
+ beginning of each line about that "extended commit info" (author,
+ email, committer, dates, summary etc).
+
+. Unlike Porcelain format, the filename information is always
+ given and terminates the entry:
+
+ "filename" <whitespace-quoted-filename-goes-here>
++
+and thus it's really quite easy to parse for some line- and word-oriented
+parser (which should be quite natural for most scripting languages).
++
+[NOTE]
+For people who do parsing: to make it more robust, just ignore any
+lines in between the first and last one ("<sha1>" and "filename" lines)
+where you don't recognize the tag-words (or care about that particular
+one) at the beginning of the "extended information" lines. That way, if
+there is ever added information (like the commit encoding or extended
+commit commentary), a blame viewer won't ever care.
+
+
SEE ALSO
--------
gitlink:git-annotate[1]
next prev parent reply other threads:[~2007-01-28 20:20 UTC|newest]
Thread overview: 92+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-01-26 11:07 More precise tag following Junio C Hamano
2007-01-26 11:53 ` Junio C Hamano
2007-01-27 8:01 ` Shawn O. Pearce
2007-01-27 8:41 ` Junio C Hamano
2007-01-27 13:33 ` Jeff King
2007-01-27 17:47 ` Nicolas Pitre
2007-01-27 9:04 ` Simon 'corecode' Schubert
2007-01-27 12:58 ` Johannes Schindelin
2007-01-27 13:50 ` Simon 'corecode' Schubert
2007-01-27 16:30 ` Jakub Narebski
2007-01-27 17:36 ` Linus Torvalds
2007-01-27 16:46 ` Johannes Schindelin
2007-01-27 17:12 ` Simon 'corecode' Schubert
2007-01-27 19:13 ` Johannes Schindelin
2007-01-27 19:55 ` Simon 'corecode' Schubert
2007-01-27 19:41 ` Nicolas Pitre
2007-01-27 17:22 ` Linus Torvalds
2007-01-27 17:56 ` Linus Torvalds
2007-01-27 22:00 ` Junio C Hamano
2007-01-27 22:54 ` Linus Torvalds
2007-01-28 9:27 ` Junio C Hamano
2007-01-28 9:44 ` [PATCH] git-blame --porcelain: quote filename in c-style when needed Junio C Hamano
2007-01-28 14:25 ` [PATCH] git-blame --incremental: don't use pager René Scharfe
2007-01-28 19:09 ` Junio C Hamano
2007-01-28 19:14 ` Junio C Hamano
2007-01-29 0:32 ` René Scharfe
2007-01-29 2:35 ` [PATCH] git blame --progress Junio C Hamano
2007-01-29 7:00 ` Simon 'corecode' Schubert
2007-01-29 16:54 ` Alex Riesen
2007-01-29 18:12 ` Matthias Lederhofer
2007-01-29 19:06 ` Junio C Hamano
2007-01-29 19:59 ` René Scharfe
2007-01-29 20:24 ` Linus Torvalds
2007-01-30 1:53 ` Junio C Hamano
2007-01-28 19:08 ` More precise tag following Linus Torvalds
2007-01-28 19:18 ` Junio C Hamano
2007-01-28 19:57 ` Linus Torvalds
2007-01-28 20:01 ` Junio C Hamano
2007-01-28 20:20 ` Junio C Hamano [this message]
2007-01-28 21:06 ` Junio C Hamano
2007-01-28 23:01 ` Jeff King
2007-01-30 9:22 ` Junio C Hamano
2007-01-30 15:31 ` Shawn O. Pearce
2007-01-30 17:02 ` Linus Torvalds
2007-01-28 19:58 ` Junio C Hamano
2007-01-29 6:18 ` Shawn O. Pearce
2007-01-29 10:17 ` Junio C Hamano
2007-01-29 10:31 ` Shawn O. Pearce
2007-01-29 16:24 ` Linus Torvalds
2007-01-29 18:07 ` Simon 'corecode' Schubert
2007-01-29 19:29 ` Theodore Tso
2007-01-29 19:45 ` Linus Torvalds
2007-01-29 20:25 ` Jakub Narebski
2007-01-29 20:47 ` Shawn O. Pearce
2007-01-29 21:02 ` Jakub Narebski
2007-02-09 7:41 ` Shawn O. Pearce
2007-01-31 8:39 ` David Kågedal
2007-01-31 10:59 ` David Kågedal
2007-01-31 16:12 ` Peter Eriksen
2007-01-31 17:04 ` David Kågedal
2007-01-31 17:12 ` Peter Eriksen
2007-01-31 17:35 ` Jakub Narebski
2007-01-31 20:59 ` David Kågedal
2007-01-27 18:40 ` Simon 'corecode' Schubert
2007-01-27 19:02 ` Johannes Schindelin
2007-01-27 19:12 ` Simon 'corecode' Schubert
2007-01-27 19:19 ` Johannes Schindelin
2007-01-27 19:59 ` Jakub Narebski
2007-01-27 19:15 ` Linus Torvalds
2007-01-27 19:25 ` Linus Torvalds
2007-01-27 19:54 ` Jakub Narebski
2007-01-27 20:13 ` Linus Torvalds
2007-01-27 19:36 ` Chris Lee
2007-01-28 18:10 ` Theodore Tso
2007-01-28 18:27 ` Linus Torvalds
2007-01-28 22:26 ` David Lang
2007-01-29 17:34 ` Nicolas Pitre
2007-01-29 17:42 ` Linus Torvalds
2007-01-29 17:58 ` Nicolas Pitre
2007-01-29 19:16 ` Chris Lee
2007-01-29 23:00 ` Eric Wong
2007-01-30 0:42 ` Eric Wong
2007-01-30 0:48 ` Eric Wong
2007-01-30 8:51 ` Eric Wong
2007-01-27 18:52 ` Jakub Narebski
2007-01-27 20:16 ` Jeff King
2007-01-27 22:39 ` Linus Torvalds
2007-01-27 23:52 ` Jeff King
2007-01-28 2:39 ` Theodore Tso
2007-01-28 3:17 ` Randal L. Schwartz
2007-01-28 13:15 ` Jeff King
2007-01-28 7:40 ` Shawn O. Pearce
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7v8xfmewdm.fsf_-_@assigned-by-dhcp.cox.net \
--to=junkio@cox.net \
--cc=git@vger.kernel.org \
--cc=torvalds@linux-foundation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).