effort docs: add note about omitting unsorted results

This commit is contained in:
Nicolai Skogheim 2015-08-08 04:21:26 +02:00
parent d51f4fde37
commit b1fba8f3fe
3 changed files with 10 additions and 1 deletions

View file

@ -46,6 +46,9 @@ Note: \fBgit\-effort\fR does not accept commit ranges\.
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

View file

@ -104,6 +104,9 @@
<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
@ -145,7 +148,7 @@ $ git effort --after="one year ago" --above 5 --author="Leila Muhtasib"
<h2 id="AUTHOR">AUTHOR</h2>
<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>
<p>Written by Leila Muhtasib &lt;<a href="&#x6d;&#x61;&#x69;&#x6c;&#116;&#x6f;&#58;&#109;&#x75;&#104;&#x74;&#97;&#115;&#x69;&#x62;&#64;&#103;&#x6d;&#x61;&#x69;&#108;&#46;&#x63;&#111;&#x6d;" data-bare-link="true">&#x6d;&#117;&#x68;&#116;&#97;&#x73;&#x69;&#x62;&#64;&#x67;&#x6d;&#97;&#x69;&#108;&#x2e;&#x63;&#x6f;&#x6d;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>

View file

@ -31,6 +31,9 @@ git-effort(1) -- Show effort statistics on file(s)
## 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.
Displays "effort" statistics:
$ git effort --above 5