utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-10 15:36:21 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

effort docs: add example with directories

Browse source
This commit is contained in:
Nicolai Skogheim 2015-08-08 04:18:32 +02:00
parent d367affd57
commit d51f4fde37
3 changed files with 52 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
man/git-effort.1
View file

@ -1,13 +1,13 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-EFFORT" "1" "July 2015" "" "Git Extras"
.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>] [<filename>]
\fBgit\-effort\fR [\-\-above <value>] [<options>] [[\-\-] <path>\.\.\.]
.
.SH "DESCRIPTION"
Shows effort statistics about files in the repository\.
@ -40,10 +40,10 @@ to read about options to limit which commits are counted\.
Note: \fBgit\-effort\fR does not accept commit ranges\.
.
.P
<filename>
[\-\-] <path>\.\.\.
.
.P
Only display effort statistics for a specific filename\.
Only count commits that touches the given paths\.
.
.SH "EXAMPLES"
Displays "effort" statistics:
@ -72,11 +72,29 @@ $ git effort \-\-after="one year ago" \-\-above 5 \-\-author="Leila Muhtasib"
file commits active days
git\-extras 15 12
git\-release 6 9
git\-release 6 4
git\-effort 6 2
git\-ignore 4 4
git\-changelog 3 5
git\-graft 2 3
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
.

26
man/git-effort.html
View file

@ -76,7 +76,7 @@
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-effort</code> [--above &lt;value&gt;] [&lt;options&gt;] [&lt;filename&gt;]</p>
<p><code>git-effort</code> [--above &lt;value&gt;] [&lt;options&gt;] [[--] &lt;path&gt;...]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@ -98,9 +98,9 @@
<p> Note: <code>git-effort</code> does not accept commit ranges.</p>
<p> &lt;filename&gt;</p>
<p> [--] &lt;path&gt;...</p>
<p> Only display effort statistics for a specific filename.</p>
<p> Only count commits that touches the given paths.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
@ -126,16 +126,26 @@ $ git effort --after="one year ago" --above 5 --author="Leila Muhtasib"
file commits active days
git-extras 15 12
git-release 6 9
git-release 6 4
git-effort 6 2
git-ignore 4 4
git-changelog 3 5
git-graft 2 3
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
file commits active days
bin.......................................... 406 232
man.......................................... 118 80
</code></pre>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Leila Muhtasib &lt;<a href="&#x6d;&#97;&#105;&#108;&#x74;&#111;&#58;&#109;&#117;&#x68;&#x74;&#97;&#x73;&#x69;&#98;&#x40;&#x67;&#109;&#97;&#x69;&#108;&#46;&#99;&#111;&#x6d;" data-bare-link="true">&#x6d;&#117;&#104;&#x74;&#97;&#x73;&#105;&#98;&#x40;&#103;&#x6d;&#97;&#x69;&#108;&#46;&#99;&#x6f;&#x6d;</a>&gt;</p>
<p>Written by Leila Muhtasib &lt;<a href="&#109;&#x61;&#105;&#x6c;&#x74;&#x6f;&#58;&#109;&#x75;&#x68;&#x74;&#97;&#x73;&#x69;&#x62;&#64;&#x67;&#x6d;&#97;&#105;&#x6c;&#46;&#x63;&#111;&#x6d;" data-bare-link="true">&#x6d;&#117;&#104;&#116;&#97;&#x73;&#x69;&#x62;&#x40;&#103;&#109;&#x61;&#x69;&#x6c;&#46;&#99;&#111;&#109;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
@ -148,7 +158,7 @@ $ git effort --after="one year ago" --above 5 --author="Leila Muhtasib"
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>July 2015</li>
<li class='tc'>August 2015</li>
<li class='tr'>git-effort(1)</li>
</ol>

9
man/git-effort.md
View file

@ -59,6 +59,15 @@ git-effort(1) -- Show effort statistics on file(s)
git-changelog 3 2
git-graft 2 2
Showing statistics on directories is also possible
$ git effort bin man
file commits active days
bin.......................................... 406 232
man.......................................... 118 80
## AUTHOR