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.
184 lines
7.1 KiB
HTML
184 lines
7.1 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
|
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
|
<title>git-effort(1) - Show effort statistics on file(s)</title>
|
|
<style type='text/css' media='all'>
|
|
/* style: man */
|
|
body#manpage {margin:0}
|
|
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
|
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
|
.mp h2 {margin:10px 0 0 0}
|
|
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
|
.mp h3 {margin:0 0 0 4ex}
|
|
.mp dt {margin:0;clear:left}
|
|
.mp dt.flush {float:left;width:8ex}
|
|
.mp dd {margin:0 0 0 9ex}
|
|
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
|
.mp pre {margin-bottom:20px}
|
|
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
|
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
|
.mp img {display:block;margin:auto}
|
|
.mp h1.man-title {display:none}
|
|
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
|
.mp h2 {font-size:16px;line-height:1.25}
|
|
.mp h1 {font-size:20px;line-height:2}
|
|
.mp {text-align:justify;background:#fff}
|
|
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
|
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
|
.mp u {text-decoration:underline}
|
|
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
|
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
|
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
|
.mp b.man-ref {font-weight:normal;color:#434241}
|
|
.mp pre {padding:0 4ex}
|
|
.mp pre code {font-weight:normal;color:#434241}
|
|
.mp h2+pre,h3+pre {padding-left:0}
|
|
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
|
ol.man-decor {width:100%}
|
|
ol.man-decor li.tl {text-align:left}
|
|
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
|
ol.man-decor li.tr {text-align:right;float:right}
|
|
</style>
|
|
</head>
|
|
<!--
|
|
The following styles are deprecated and will be removed at some point:
|
|
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
|
|
|
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
|
.man-navigation should be used instead.
|
|
-->
|
|
<body id='manpage'>
|
|
<div class='mp' id='man'>
|
|
|
|
<div class='man-navigation' style='display:none'>
|
|
<a href="#NAME">NAME</a>
|
|
<a href="#SYNOPSIS">SYNOPSIS</a>
|
|
<a href="#DESCRIPTION">DESCRIPTION</a>
|
|
<a href="#OPTIONS">OPTIONS</a>
|
|
<a href="#EXAMPLES">EXAMPLES</a>
|
|
<a href="#AUTHOR">AUTHOR</a>
|
|
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
|
|
<a href="#SEE-ALSO">SEE ALSO</a>
|
|
</div>
|
|
|
|
<ol class='man-decor man-head man head'>
|
|
<li class='tl'>git-effort(1)</li>
|
|
<li class='tc'>Git Extras</li>
|
|
<li class='tr'>git-effort(1)</li>
|
|
</ol>
|
|
|
|
<h2 id="NAME">NAME</h2>
|
|
<p class="man-name">
|
|
<code>git-effort</code> - <span class="man-whatis">Show effort statistics on file(s)</span>
|
|
</p>
|
|
|
|
<h2 id="SYNOPSIS">SYNOPSIS</h2>
|
|
|
|
<p><code>git-effort</code> [--above <value>] [<path>...] [-- [<log options>...]]</p>
|
|
|
|
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
|
|
<p> Shows effort statistics about files in the repository.</p>
|
|
|
|
<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.</p>
|
|
|
|
<h2 id="OPTIONS">OPTIONS</h2>
|
|
|
|
<p> --above <value></p>
|
|
|
|
<p> Ignore files with commits <= a value.</p>
|
|
|
|
<p> <path>...</p>
|
|
|
|
<p> Only count commits that touches the given paths.</p>
|
|
|
|
<p> Note: <code>git-effort</code> does not accept revision ranges, but the underlying <code>git log</code> does (See the examples).</p>
|
|
|
|
<p> <log options>...</p>
|
|
|
|
<p> Options for <code>git log</code>. Note that you must use <code>--</code> to separate options to <code>git log</code>
|
|
from options to <code>git effort</code>.
|
|
This makes it possible to only count commits you are interested in.
|
|
Not all options are relevant in the context of <code>git-effort</code>, but those that are is listed under the "Commit Limiting" section on the <code>git-log</code> manpages.</p>
|
|
|
|
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
|
|
<p> 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>
|
|
|
|
<p> Displays "effort" statistics:</p>
|
|
|
|
<pre><code>$ 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
|
|
</code></pre>
|
|
|
|
<p> Showing statistics on directories is also possible:</p>
|
|
|
|
<pre><code>$ git effort bin man -- --after="one year ago"
|
|
|
|
file commits active days
|
|
|
|
bin.......................................... 406 232
|
|
man.......................................... 118 80
|
|
</code></pre>
|
|
|
|
<p> Only count commits in the specified revision range:</p>
|
|
|
|
<p> $ git effort -- master..feature</p>
|
|
|
|
<pre><code> file commits active days
|
|
|
|
bin/git-effort............................... 3 2
|
|
man/git-effort.md............................ 1 1
|
|
</code></pre>
|
|
|
|
<h2 id="AUTHOR">AUTHOR</h2>
|
|
|
|
<p>Written by Leila Muhtasib <<a href="mailto:muhtasib@gmail.com" data-bare-link="true">muhtasib@gmail.com</a>></p>
|
|
|
|
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
|
|
|
|
<p><<a href="https://github.com/tj/git-extras/issues" data-bare-link="true">https://github.com/tj/git-extras/issues</a>></p>
|
|
|
|
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
|
|
<p><<a href="https://github.com/tj/git-extras" data-bare-link="true">https://github.com/tj/git-extras</a>></p>
|
|
|
|
|
|
<ol class='man-decor man-foot man foot'>
|
|
<li class='tl'></li>
|
|
<li class='tc'>September 2015</li>
|
|
<li class='tr'>git-effort(1)</li>
|
|
</ol>
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|