guilt: document call without arguments

This commit is contained in:
Nicolai Skogheim 2015-08-06 05:43:06 +02:00
parent a212a78c1b
commit aeebb1c1c1
3 changed files with 61 additions and 13 deletions

View file

@ -7,10 +7,16 @@
\fBgit\-guilt\fR \- calculate change between two revisions
.
.SH "SYNOPSIS"
git guilt [<option>] <since> <until>
\fBgit guilt\fR [<option>]
.
.br
\fBgit guilt\fR [<option>] <since> [<until>]
.
.SH "DESCRIPTION"
Calculate the change in blame between two revisions
In the first form, shows total blame count for files with unstaged changes\.
.
.P
In the second form, calculates the change in blame between two revisions\. If not specified, <until> will default to HEAD\.
.
.SH "OPTIONS"
\-h, \-\-help
@ -37,13 +43,30 @@ Ignore whitespace only changes when attributing blame
Output debug information
.
.SH "Examples"
Find blame on unstaged modified files:
.
.IP "" 4
.
.nf
$ git guilt (1)
spacewander ++++
(1) There is only one modified file and it is not staged\. The four
plusses means that the file has four lines, all contributed by spacewander\.
.
.fi
.
.IP "" 0
.
.P
Find blame delta between two commits:
.
.IP "" 4
.
.nf
$ git guilt HEAD~2 HEAD
$ git guilt HEAD~3 HEAD^
spacewander +++++++++++++++++++++++++++++++++++++++++++++(115)
Jesse Sipprell \-
.
@ -58,7 +81,7 @@ Find blame delta over the last three weeks:
.
.nf
$ git guilt `git log \-\-until="3 weeks ago" \-\-format="%H" \-n 1` HEAD
$ git guilt `git log \-\-until="3 weeks ago" \-\-format="%H" \-n 1`
Paul Schreiber +++++++++++++++++++++++++++++++++++++++++++++(349)
spacewander +++++++++++++++++++++++++++++++++++++++++++++(113)
Mark Eissler ++++++++++++++++++++++++++

View file

@ -76,11 +76,15 @@
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p>git guilt [&lt;option&gt;] &lt;since&gt; &lt;until&gt;</p>
<p><code>git guilt</code> [&lt;option&gt;]<br />
<code>git guilt</code> [&lt;option&gt;] &lt;since&gt; [&lt;until&gt;]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Calculate the change in blame between two revisions</p>
<p>In the first form, shows total blame count for files with unstaged changes.</p>
<p>In the second form, calculates the change in blame between two revisions.
If not specified, &lt;until&gt; will default to HEAD.</p>
<h2 id="OPTIONS">OPTIONS</h2>
@ -102,16 +106,25 @@
<h2 id="Examples">Examples</h2>
<p>Find blame on unstaged modified files:</p>
<pre><code>$ git guilt (1)
spacewander ++++
(1) There is only one modified file and it is not staged. The four
plusses means that the file has four lines, all contributed by spacewander.
</code></pre>
<p>Find blame delta between two commits:</p>
<pre><code>$ git guilt HEAD~2 HEAD
<pre><code>$ git guilt HEAD~3 HEAD^
spacewander +++++++++++++++++++++++++++++++++++++++++++++(115)
Jesse Sipprell -
</code></pre>
<p>Find blame delta over the last three weeks:</p>
<pre><code>$ git guilt `git log --until="3 weeks ago" --format="%H" -n 1` HEAD
<pre><code>$ git guilt `git log --until="3 weeks ago" --format="%H" -n 1`
Paul Schreiber +++++++++++++++++++++++++++++++++++++++++++++(349)
spacewander +++++++++++++++++++++++++++++++++++++++++++++(113)
Mark Eissler ++++++++++++++++++++++++++
@ -135,7 +148,7 @@ spacewander +++++++++++++++++++++++++++++++++++++++++++++(112)
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by spacewander &lt;<a href="&#x6d;&#97;&#105;&#108;&#116;&#x6f;&#58;&#115;&#x70;&#x61;&#x63;&#101;&#x77;&#97;&#110;&#100;&#101;&#x72;&#x6c;&#x7a;&#120;&#64;&#x67;&#109;&#97;&#x69;&#108;&#46;&#x63;&#111;&#109;" data-bare-link="true">&#x73;&#112;&#x61;&#x63;&#101;&#119;&#97;&#x6e;&#x64;&#x65;&#114;&#108;&#122;&#120;&#64;&#x67;&#x6d;&#x61;&#105;&#108;&#x2e;&#99;&#x6f;&#x6d;</a>&gt;</p>
<p>Written by spacewander &lt;<a href="&#x6d;&#97;&#x69;&#108;&#x74;&#x6f;&#x3a;&#115;&#112;&#97;&#99;&#x65;&#x77;&#97;&#x6e;&#100;&#101;&#114;&#108;&#122;&#120;&#64;&#x67;&#x6d;&#x61;&#x69;&#x6c;&#46;&#99;&#111;&#x6d;" data-bare-link="true">&#x73;&#112;&#97;&#x63;&#x65;&#119;&#97;&#110;&#100;&#101;&#114;&#x6c;&#122;&#120;&#x40;&#103;&#109;&#x61;&#105;&#x6c;&#x2e;&#99;&#111;&#x6d;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>

View file

@ -3,11 +3,15 @@ git-guilt(1) -- calculate change between two revisions
## SYNOPSIS
git guilt [&lt;option&gt;] &lt;since&gt; &lt;until&gt;
`git guilt` [&lt;option&gt;]<br>
`git guilt` [&lt;option&gt;] &lt;since&gt; [&lt;until&gt;]
## DESCRIPTION
Calculate the change in blame between two revisions
In the first form, shows total blame count for files with unstaged changes.
In the second form, calculates the change in blame between two revisions.
If not specified, &lt;until&gt; will default to HEAD.
## OPTIONS
@ -29,15 +33,23 @@ Calculate the change in blame between two revisions
## Examples
Find blame on unstaged modified files:
$ git guilt (1)
spacewander ++++
(1) There is only one modified file and it is not staged. The four
plusses means that the file has four lines, all contributed by spacewander.
Find blame delta between two commits:
$ git guilt HEAD~2 HEAD
$ git guilt HEAD~3 HEAD^
spacewander +++++++++++++++++++++++++++++++++++++++++++++(115)
Jesse Sipprell -
Find blame delta over the last three weeks:
$ git guilt `git log --until="3 weeks ago" --format="%H" -n 1` HEAD
$ git guilt `git log --until="3 weeks ago" --format="%H" -n 1`
Paul Schreiber +++++++++++++++++++++++++++++++++++++++++++++(349)
spacewander +++++++++++++++++++++++++++++++++++++++++++++(113)
Mark Eissler ++++++++++++++++++++++++++