mirror of
https://github.com/tj/git-extras.git
synced 2026-09-10 07:26:17 -04:00
86e1a7014c
Why: * The old way of handling arguments could make it difficult to make non-breaking changes because to be able to handle more arguments than the '--above' argument, the logic would need to be heavily refactored and demand restrictions on argument order. This change addresses the need by: * Parse arguments in a cleaner way * Make the command more future proof with respect to arguments Notable change is the synopsis. Please the see man page.
130 lines
3.6 KiB
Groff
130 lines
3.6 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "GIT\-EFFORT" "1" "September 2015" "" "Git Extras"
|
|
.
|
|
.SH "NAME"
|
|
\fBgit\-effort\fR \- Show effort statistics on file(s)
|
|
.
|
|
.SH "SYNOPSIS"
|
|
\fBgit\-effort\fR [\-\-above <value>] [<path>\.\.\.] [\-\- [<log options>\.\.\.]]
|
|
.
|
|
.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
|
|
<path>\.\.\.
|
|
.
|
|
.P
|
|
Only count commits that touches the given paths\.
|
|
.
|
|
.P
|
|
Note: \fBgit\-effort\fR does not accept revision ranges, but the underlying \fBgit log\fR does (See the examples)\.
|
|
.
|
|
.P
|
|
<log options>\.\.\.
|
|
.
|
|
.P
|
|
Options for \fBgit log\fR\. Note that you must use \fB\-\-\fR to separate options to \fBgit log\fR from options to \fBgit effort\fR\. This makes it possible to only count commits you are interested in\. Not all options are relevant in the context of \fBgit\-effort\fR, but those that are is listed under the "Commit Limiting" section on the \fBgit\-log\fR manpages\.
|
|
.
|
|
.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 \-\-above 5 bin/* \-\- \-\-after="one year ago" \-\-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 \-\- \-\-after="one year ago"
|
|
|
|
file commits active days
|
|
|
|
bin\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\. 406 232
|
|
man\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\. 118 80
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Only count commits in the specified revision range:
|
|
.
|
|
.P
|
|
$ git effort \-\- master\.\.feature
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
file commits active days
|
|
|
|
bin/git\-effort\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\. 3 2
|
|
man/git\-effort\.md\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\. 1 1
|
|
.
|
|
.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>
|