Merge pull request #110 from muhtasib/docs_git_effort

Docs git effort
This commit is contained in:
TJ Holowaychuk 2012-06-12 14:48:04 -07:00
commit 363338a55e
7 changed files with 316 additions and 11 deletions

42
man/Readme.md Normal file
View file

@ -0,0 +1,42 @@
How to generate documentation:
================================
## DESCRIPTION
To generate documentation:
1) Start by filling out the 'man-template.md'
2) Then use a program ronn. Get ronn from github.
3) Run ronn:
$ronn <filename>.md
4) Remember, we use the following naming convention for files:
git-<command>.html
git-<command>.1
git-<command>.md
You'll need to rename the html file, as ronn probably inserted a 1 into the filename.
## EXAMPLE
$ ronn git-effort.md
roff: ./git-effort.1
html: ./git-effort.1.html +man
$mv git-effort.1.html git-effort.html
## AUTHOR
Written by Leila Muhtasib &lt;<muhtasib@gmail.com>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

68
man/git-effort.1 Normal file
View file

@ -0,0 +1,68 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-EFFORT" "1" "June 2012" "" ""
.
.SH "NAME"
\fBgit\-effort\fR \- Show effort statistics on file(s)
.
.SH "SYNOPSIS"
\fBgit\-effort\fR [\-\-above <value>] [<filename>]
.
.SH "DESCRIPTION"
Shows effort statistics about files in the repository\.
.
.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\.
.
.SH "OPTIONS"
\-\-above <value>
.
.P
Ignore files with commits <= a value\.
.
.P
<filename>
.
.P
Only display effort statistics for a specific filename\.
.
.SH "EXAMPLES"
Displays "effort" statistics:
.
.IP "" 4
.
.nf
$ 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
.
.fi
.
.IP "" 0
.
.SH "AUTHOR"
Written by Leila Muhtasib <\fImuhtasib@gmail\.com\fR>
.
.SH "REPORTING BUGS"
<\fIhttp://github\.com/visionmedia/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttp://github\.com/visionmedia/git\-extras\fR>

139
man/git-effort.html Normal file
View file

@ -0,0 +1,139 @@
<!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'></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 &lt;value&gt;] [&lt;filename&gt;]</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 &lt;value&gt;</p>
<p> Ignore files with commits &lt;= a value.</p>
<p> &lt;filename&gt;</p>
<p> Only display effort statistics for a specific filename.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<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
</code></pre>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Leila Muhtasib &lt;<a data-bare-link="true" href="&#x6d;&#x61;&#x69;&#108;&#x74;&#111;&#58;&#109;&#x75;&#104;&#x74;&#97;&#115;&#105;&#98;&#x40;&#x67;&#x6d;&#x61;&#105;&#108;&#x2e;&#x63;&#x6f;&#x6d;">&#x6d;&#117;&#x68;&#x74;&#97;&#x73;&#105;&#x62;&#64;&#x67;&#109;&#97;&#x69;&#108;&#x2e;&#x63;&#x6f;&#x6d;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
<p>&lt;<a data-bare-link="true" href="http://github.com/visionmedia/git-extras/issues">http://github.com/visionmedia/git-extras/issues</a>&gt;</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p>&lt;<a data-bare-link="true" href="http://github.com/visionmedia/git-extras">http://github.com/visionmedia/git-extras</a>&gt;</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>June 2012</li>
<li class='tr'>git-effort(1)</li>
</ol>
</div>
</body>
</html>

55
man/git-effort.md Normal file
View file

@ -0,0 +1,55 @@
git-effort(1) -- Show effort statistics on file(s)
=================================
## SYNOPSIS
`git-effort` [--above &lt;value&gt;] [&lt;filename&gt;]
## DESCRIPTION
Shows effort statistics about files in the repository.
Display includes:
- Commits: number of commits per file - highlighting files with most activity.
- Active days: total number of days which contributed modifications to this file.
## OPTIONS
--above &lt;value&gt;
Ignore files with commits &lt;= a value.
&lt;filename&gt;
Only display effort statistics for a specific filename.
## EXAMPLES
Displays "effort" statistics:
$ 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
## AUTHOR
Written by Leila Muhtasib &lt;<muhtasib@gmail.com>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

View file

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-EXTRAS" "1" "March 2011" "" "Git Extras"
.TH "GIT\-EXTRAS" "1" "June 2012" "" ""
.
.SH "NAME"
\fBgit\-extras\fR \- Awesome GIT utilities
@ -24,6 +24,9 @@
\fBgit\-count\fR show commit count
.
.IP "\(bu" 4
\fBgit\-effort\fR show effort statistics on file(s)
.
.IP "\(bu" 4
\fBgit\-fresh\-branch\fR create fresh branches
.
.IP "\(bu" 4
@ -50,9 +53,6 @@
.IP "\(bu" 4
\fBgit\-undo\fR undo one or more of the latest commits
.
.IP "\(bu" 4
\fBgit\-pull\-request\fR pulls the given request from github
.
.IP "" 0
.
.SH "AUTHOR"

View file

@ -59,11 +59,11 @@
<a href="#AUTHOR">AUTHOR</a>
<a href="#REPORTING-BUGS">REPORTING BUGS</a>
<a href="#SEE-ALSO">SEE ALSO</a>
</div>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>git-extras(1)</li>
<li class='tc'>Git Extras</li>
<li class='tc'></li>
<li class='tr'>git-extras(1)</li>
</ol>
@ -83,6 +83,7 @@
<li> <code>git-commits-since</code> show commit logs since some date</li>
<li> <code>git-contrib</code> show a user's contribution</li>
<li> <code>git-count</code> show commit count</li>
<li> <code>git-effort</code> show effort statistics on file(s)</li>
<li> <code>git-fresh-branch</code> create fresh branches</li>
<li> <code>git-graft</code> merge and destroy a given branch</li>
<li> <code>git-ignore</code> add .gitignore patterns</li>
@ -92,26 +93,25 @@
<li> <code>git-summary</code> repository summary &amp; contrib</li>
<li> <code>git-touch</code> touch and add file to the index</li>
<li> <code>git-undo</code> undo one or more of the latest commits</li>
<li> <code>git-pull-request</code> pulls the given request from github</li>
</ul>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Tj Holowaychuk &lt;<a href="&#x6d;&#x61;&#105;&#x6c;&#116;&#x6f;&#x3a;&#116;&#x6a;&#x40;&#x76;&#x69;&#115;&#105;&#x6f;&#x6e;&#x2d;&#x6d;&#101;&#100;&#105;&#x61;&#x2e;&#99;&#97;" data-bare-link="true">&#116;&#106;&#x40;&#118;&#105;&#x73;&#x69;&#x6f;&#110;&#x2d;&#x6d;&#x65;&#100;&#x69;&#97;&#x2e;&#99;&#x61;</a>&gt;</p>
<p>Written by Tj Holowaychuk &lt;<a data-bare-link="true" href="&#109;&#x61;&#105;&#108;&#116;&#x6f;&#x3a;&#116;&#x6a;&#x40;&#118;&#105;&#x73;&#x69;&#x6f;&#x6e;&#x2d;&#109;&#x65;&#100;&#x69;&#x61;&#46;&#x63;&#x61;">&#116;&#x6a;&#x40;&#x76;&#x69;&#x73;&#105;&#111;&#x6e;&#45;&#109;&#101;&#x64;&#105;&#x61;&#x2e;&#x63;&#97;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
<p>&lt;<a href="http://github.com/visionmedia/git-extras/issues" data-bare-link="true">http://github.com/visionmedia/git-extras/issues</a>&gt;</p>
<p>&lt;<a data-bare-link="true" href="http://github.com/visionmedia/git-extras/issues">http://github.com/visionmedia/git-extras/issues</a>&gt;</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p>&lt;<a href="http://github.com/visionmedia/git-extras" data-bare-link="true">http://github.com/visionmedia/git-extras</a>&gt;</p>
<p>&lt;<a data-bare-link="true" href="http://github.com/visionmedia/git-extras">http://github.com/visionmedia/git-extras</a>&gt;</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>March 2011</li>
<li class='tc'>June 2012</li>
<li class='tr'>git-extras(1)</li>
</ol>

View file

@ -11,6 +11,7 @@ git-extras(1) -- Awesome GIT utilities
- `git-commits-since` show commit logs since some date
- `git-contrib` show a user's contribution
- `git-count` show commit count
- `git-effort` show effort statistics on file(s)
- `git-fresh-branch` create fresh branches
- `git-graft` merge and destroy a given branch
- `git-ignore` add .gitignore patterns