diff options
| author | Junio C Hamano <junkio@cox.net> | 2006-10-12 00:44:27 -0700 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2006-10-12 00:44:27 -0700 |
| commit | b24642b2f27b2cf01f6e726d816a2a1f5955ae3e (patch) | |
| tree | b889dd75b22f66350e7c3143a5a4b72ffcfac2e6 /Documentation/git-blame.txt | |
| parent | f789e347465dded7fcec3a605473fa3f549792d8 (diff) | |
| download | git-b24642b2f27b2cf01f6e726d816a2a1f5955ae3e.tar.gz | |
blame: Document and add help text for -f, -n, and -p
New options --show-name, --show-number and --porcelain were not
documented. Also add -p as a short-hand for --porcelain for
consistency.
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-blame.txt')
| -rw-r--r-- | Documentation/git-blame.txt | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index e1f89444a9..9891c1d377 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -7,7 +7,7 @@ git-blame - Show what revision and author last modified each line of a file SYNOPSIS -------- -'git-blame' [-c] [-l] [-t] [-S <revs-file>] [--] <file> [<rev>] +'git-blame' [-c] [-l] [-t] [-f] [-n] [-p] [-S <revs-file>] [--] <file> [<rev>] DESCRIPTION ----------- @@ -45,10 +45,47 @@ OPTIONS -S, --rev-file <revs-file>:: Use revs from revs-file instead of calling gitlink:git-rev-list[1]. +-f, --show-name:: + Show filename in the original commit. By default + filename is shown if there is any line that came from a + file with different name, due to rename detection. + +-n, --show-number:: + Show line number in the original commit (Default: off). + +-p, --porcelain:: + Show in a format designed for machine consumption. + -h, --help:: Show help message. +THE PORCELAIN FORMAT +-------------------- + +In this format, each line is output after a header; the +header at the minumum has the first line which has: + +- 40-byte SHA-1 of the commit the line is attributed to; +- the line number of the line in the original file; +- the line number of the line in the final file; +- on a line that starts a group of line from a different + commit than the previous one, the number of lines in this + group. On subsequent lines this field is absent. + +This header line is followed by the following information +at least once for each commit: + +- author name ("author"), email ("author-mail"), time + ("author-time"), and timezone ("author-tz"); similarly + for committer. +- filename in the commit the line is attributed to. +- the first line of the commit log message ("summary"). + +The contents of the actual line is output after the above +header, prefixed by a TAB. This is to allow adding more +header elements later. + SEE ALSO -------- gitlink:git-annotate[1] |