Add info about new options to man pages

This commit is contained in:
Nicolai Skogheim 2015-07-24 18:03:12 +02:00
parent 6ba68941e8
commit 78de79ce96
3 changed files with 67 additions and 8 deletions

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" "April 2015" "" ""
.TH "GIT\-EFFORT" "1" "July 2015" "" "Git Extras"
.
.SH "NAME"
\fBgit\-effort\fR \- Show effort statistics on file(s)
.
.SH "SYNOPSIS"
\fBgit\-effort\fR [\-\-above <value>] [<filename>]
\fBgit\-effort\fR [\-\-above <value>] [<options>] [<filename>]
.
.SH "DESCRIPTION"
Shows effort statistics about files in the repository\.
@ -28,6 +28,18 @@ Display includes:
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
<filename>
.
.P
@ -53,6 +65,18 @@ $ git effort \-\-above 5
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 9
git\-effort 6 2
git\-ignore 4 4
git\-changelog 3 5
git\-graft 2 3
.
.fi
.

View file

@ -65,7 +65,7 @@
<ol class='man-decor man-head man head'>
<li class='tl'>git-effort(1)</li>
<li class='tc'></li>
<li class='tc'>Git Extras</li>
<li class='tr'>git-effort(1)</li>
</ol>
@ -76,7 +76,7 @@
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-effort</code> [--above &lt;value&gt;] [&lt;filename&gt;]</p>
<p><code>git-effort</code> [--above &lt;value&gt;] [&lt;options&gt;] [&lt;filename&gt;]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
@ -92,6 +92,12 @@
<p> Ignore files with commits &lt;= a value.</p>
<p> Run<br />
man -P 'less +/Commit\ Limiting' git-log<br />
to read about options to limit which commits are counted.</p>
<p> Note: <code>git-effort</code> does not accept commit ranges.</p>
<p> &lt;filename&gt;</p>
<p> Only display effort statistics for a specific filename.</p>
@ -113,11 +119,23 @@
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 9
git-effort 6 2
git-ignore 4 4
git-changelog 3 5
git-graft 2 3
</code></pre>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Leila Muhtasib &lt;<a href="&#109;&#97;&#x69;&#108;&#116;&#x6f;&#x3a;&#x6d;&#117;&#104;&#116;&#x61;&#x73;&#x69;&#x62;&#64;&#x67;&#x6d;&#97;&#105;&#x6c;&#x2e;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#x6d;&#117;&#x68;&#116;&#97;&#115;&#105;&#98;&#x40;&#103;&#x6d;&#97;&#105;&#108;&#46;&#99;&#111;&#x6d;</a>&gt;</p>
<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>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
@ -130,7 +148,7 @@
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>April 2015</li>
<li class='tc'>July 2015</li>
<li class='tr'>git-effort(1)</li>
</ol>

View file

@ -3,7 +3,7 @@ git-effort(1) -- Show effort statistics on file(s)
## SYNOPSIS
`git-effort` [--above &lt;value&gt;] [&lt;filename&gt;]
`git-effort` [--above &lt;value&gt;] [&lt;options&gt;] [&lt;filename&gt;]
## DESCRIPTION
@ -19,6 +19,12 @@ git-effort(1) -- Show effort statistics on file(s)
Ignore files with commits &lt;= a value.
Run
man -P 'less +/Commit\ Limiting' git-log
to read about options to limit which commits are counted.
Note: `git-effort` does not accept commit ranges.
&lt;filename&gt;
Only display effort statistics for a specific filename.
@ -42,6 +48,17 @@ git-effort(1) -- Show effort statistics on file(s)
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 9
git-effort 6 2
git-ignore 4 4
git-changelog 3 5
git-graft 2 3
## AUTHOR
Written by Leila Muhtasib &lt;<muhtasib@gmail.com>&gt;
@ -52,4 +69,4 @@ Written by Leila Muhtasib &lt;<muhtasib@gmail.com>&gt;
## SEE ALSO
&lt;<https://github.com/tj/git-extras>&gt;
&lt;<https://github.com/tj/git-extras>&gt;