-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update git-annotate/git-blame documentation
Moved options that pertained to both git-blame and git-annotate to a common file blame-options.txt. builtin-blame.c: Removed --compatibility, --long, --time from the short usage as they are not handled in the code. Documentation/git-blame.txt: Removed common options to git-annotate. Added documentation for --score-debug. Removed --compatibility. Adjusted usage at top to not wrap on 80 columns. Documentation/git-annotate.txt: Using common options blame-options.txt. Documentation/blame-options.txt: Added -b note about associated config option, added --root note about associated config option, added documentation for --show-stats. Removed --long, --time, --rev-file as those options do not really exist. Added documentation for -M/-C taking an optional score argument for detection of moved lines. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
- Loading branch information
Andrew Ruder
authored and
Junio C Hamano
committed
Apr 16, 2007
1 parent
0b9a9dd
commit 635f4a3
Showing
4 changed files
with
85 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
-b:: | ||
Show blank SHA-1 for boundary commits. This can also | ||
be controlled via the `blame.blankboundary` config option. | ||
|
||
--root:: | ||
Do not treat root commits as boundaries. This can also be | ||
controlled via the `blame.showroot` config option. | ||
|
||
--show-stats:: | ||
Include additional statistics at the end of blame output. | ||
|
||
-L n,m:: | ||
Annotate only the specified line range (lines count from 1). | ||
|
||
-l:: | ||
Show long rev (Default: off). | ||
|
||
-t:: | ||
Show raw timestamp (Default: off). | ||
|
||
-S <revs-file>:: | ||
Use revs from revs-file instead of calling gitlink:git-rev-list[1]. | ||
|
||
-p, --porcelain:: | ||
Show in a format designed for machine consumption. | ||
|
||
--incremental:: | ||
Show the result incrementally in a format designed for | ||
machine consumption. | ||
|
||
--contents <file>:: | ||
When <rev> is not specified, the command annotates the | ||
changes starting backwards from the working tree copy. | ||
This flag makes the command pretend as if the working | ||
tree copy has the contents of he named file (specify | ||
`-` to make the command read from the standard input). | ||
|
||
-M|<num>|:: | ||
Detect moving lines in the file as well. When a commit | ||
moves a block of lines in a file (e.g. the original file | ||
has A and then B, and the commit changes it to B and | ||
then A), traditional 'blame' algorithm typically blames | ||
the lines that were moved up (i.e. B) to the parent and | ||
assigns blame to the lines that were moved down (i.e. A) | ||
to the child commit. With this option, both groups of lines | ||
are blamed on the parent. | ||
|
||
<num> is optional but it is the lower bound on the number of | ||
alphanumeric characters that git must detect as moving | ||
within a file for it to associate those lines with the parent | ||
commit. | ||
|
||
-C|<num>|:: | ||
In addition to `-M`, detect lines copied from other | ||
files that were modified in the same commit. This is | ||
useful when you reorganize your program and move code | ||
around across files. When this option is given twice, | ||
the command looks for copies from all other files in the | ||
parent for the commit that creates the file in addition. | ||
|
||
<num> is optional but it is the lower bound on the number of | ||
alphanumeric characters that git must detect as moving | ||
between files for it to associate those lines with the parent | ||
commit. | ||
|
||
-h, --help:: | ||
Show help message. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters