tj.git-extras/man/git-effort.1
2015-08-08 09:06:54 +02:00

114 lines
2.9 KiB
Groff

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-EFFORT" "1" "August 2015" "" "Git Extras"
.
.SH "NAME"
\fBgit\-effort\fR \- Show effort statistics on file(s)
.
.SH "SYNOPSIS"
\fBgit\-effort\fR [\-\-above <value>] [<options>] [[\-\-] <path>\.\.\.]
.
.SH "DESCRIPTION"
Shows effort statistics about files in the repository\.
.
.P
Display includes:
.
.br
\- Commits: number of commits per file \- highlighting files with most activity\.
.
.br
\- Active days: total number of days which contributed modifications to this file\.
.
.SH "OPTIONS"
\-\-above <value>
.
.P
Ignore files with commits <= a value\.
.
.P
Run
.
.br
man \-P \'less +/Commit\e Limiting\' git\-log
.
.br
to read about options to limit which commits are counted\.
.
.P
Note: \fBgit\-effort\fR does not accept commit ranges\.
.
.P
[\-\-] <path>\.\.\.
.
.P
Only count commits that touches the given paths\.
.
.SH "EXAMPLES"
Note: Output will first appear unsorted, then the screen is cleared and the sorted list is output\. The initial unsorted list is not shown in the examples for brevity\.
.
.P
Displays "effort" statistics:
.
.IP "" 4
.
.nf
$ git effort \-\-above 5
file commits active days
git\-extras 26 18
git\-release 13 13
git\-effort 13 2
git\-ignore 11 7
git\-changelog 11 8
git\-graft 9 6
git\-summary 8 6
git\-delete\-branch 8 6
git\-repl 7 5
$ git effort \-\-after="one year ago" \-\-above 5 \-\-author="Leila Muhtasib"
file commits active days
git\-extras 15 12
git\-release 6 4
git\-effort 6 2
git\-ignore 4 4
git\-changelog 3 2
git\-graft 2 2
.
.fi
.
.IP "" 0
.
.P
Showing statistics on directories is also possible
.
.IP "" 4
.
.nf
$ git effort bin man
file commits active days
bin\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\. 406 232
man\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\. 118 80
.
.fi
.
.IP "" 0
.
.SH "AUTHOR"
Written by Leila Muhtasib <\fImuhtasib@gmail\.com\fR>
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>