Merge pull request #373 from zlx/feature/document_line_summary

Document for git-line-summary
This commit is contained in:
hemanth.hm 2015-05-15 12:23:57 +05:30
commit aecef0eaed
6 changed files with 538 additions and 1 deletions

View file

@ -2,6 +2,7 @@
- [`git extras`](#git-extras)
- [`git squash`](#git-squash)
- [`git summary`](#git-summary)
- [`git line-summary`](#git-line-summary)
- [`git effort`](#git-effort)
- [`git authors`](#git-authors)
- [`git changelog`](#git-changelog)
@ -179,6 +180,10 @@ project : git-extras
1 Daniel Schildt 0.0%
```
## git line-summary
WARNING: git line-summary has been replaced by git summary --line and will be removed in a future release.
## git effort
Displays "effort" statistics, currently just the number of commits per file, showing highlighting where the most activity is. The "active days" column is the total number of days which contributed modifications to this file.
@ -843,4 +848,4 @@ The above merges `other-repo.git`'s `master` branch into the current repository
$ git merge-repo git@github.com:tj/git-extras.git master .
```
The above merges a remote repo's `master` branch into the current repository's directory, not preserving history.
The above merges a remote repo's `master` branch into the current repository's directory, not preserving history.

123
man/git-line-summary.1 Normal file
View file

@ -0,0 +1,123 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-LINE\-SUMMARY" "1" "May 2015" "" ""
.
.SH "NAME"
\fBgit\-line\-summary\fR \- Show repository summary by line
.
.SH "SYNOPSIS"
\fBgit\-line\-summary\fR
.
.SH "DESCRIPTION"
Show a summary by line of the repository, rather than by commit like git\-summary\.
.
.SH "EXAMPLES"
Outputs a repo summary by line\.
.
.IP "" 4
.
.nf
$ git line\-summary
project : git\-extras
lines : 16004
authors :
7757 hemanth\.hm 48\.5%
1019 spacewander 6\.4%
916 CJ 5\.7%
768 Jonhnny Weslley 4\.8%
711 Mark Eissler 4\.4%
678 timfeirg 4\.2%
474 Ivan Malopinsky 3\.0%
387 nickl\- 2\.4%
368 Tj Holowaychuk 2\.3%
337 Paul Schreiber 2\.1%
269 Jesús Espino 1\.7%
266 wooorm 1\.7%
236 Chris Hall 1\.5%
217 TJ Holowaychuk 1\.4%
205 Leila Muhtasib 1\.3%
178 Hemanth\.HM 1\.1%
107 Niklas Fiekas 0\.7%
80 Andy 0\.5%
74 soffolk 0\.5%
68 Julio Napurí 0\.4%
67 Philipp Klose 0\.4%
66 Sasha Khamkov 0\.4%
66 Nate Jones 0\.4%
65 Kenneth Reitz 0\.4%
64 Rico Sta\. Cruz 0\.4%
49 Bruno Sutic 0\.3%
36 chernjie 0\.2%
35 Titus Wormer 0\.2%
35 Michael Komitee 0\.2%
33 David Hartmann 0\.2%
28 Kevin Woo 0\.2%
27 Todd Wolfson 0\.2%
22 David Baumgold 0\.1%
22 Carl Casbolt 0\.1%
18 Ciro Nunes 0\.1%
18 Andrew Starr\-Bochicchio 0\.1%
16 Valérian Galliat 0\.1%
16 Riceball LEE 0\.1%
16 Damian Krzeminski 0\.1%
12 nulltask 0\.1%
12 Richard Littauer 0\.1%
11 Jesse Sipprell 0\.1%
10 meza 0\.1%
10 dead\-horse 0\.1%
9 Kylie McClain 0\.1%
9 Camille Reynders 0\.1%
8 Jon Ander Peñalba 0\.0%
8 Guillaume Seren 0\.0%
8 Adam Parkin 0\.0%
7 Newell Zhu 0\.0%
7 Florian H 0\.0%
7 Andre Cerqueira 0\.0%
6 zeroDivisible 0\.0%
6 Rasmus Wriedt Larsen 0\.0%
6 Konstantin Schukraft 0\.0%
5 Dan Jackson 0\.0%
4 jykntr 0\.0%
3 phigoro 0\.0%
3 eszabpt 0\.0%
3 Raphael Fleischlin 0\.0%
3 Curtis McEnroe 0\.0%
3 Balazs Nadasdi 0\.0%
3 Alex McHale 0\.0%
2 Not Committed Yet 0\.0%
2 Joshua Appelman 0\.0%
2 Evan Grim 0\.0%
2 Dave James Miller 0\.0%
2 Alexander Krasnukhin 0\.0%
2 Aggelos Orfanakos 0\.0%
1 Wil Moore III 0\.0%
1 TweeKane 0\.0%
1 Tony 0\.0%
1 Ryan Bohn 0\.0%
1 Rob Kennedy 0\.0%
1 Phally 0\.0%
1 Moritz Grauel 0\.0%
1 Jonathan "Duke" Leto 0\.0%
1 Jianjin Fan 0\.0%
1 Jean Jordaan 0\.0%
1 Jan Krueger 0\.0%
1 Hogan Long 0\.0%
1 Dung Quang 0\.0%
1 Brandon Zylstra 0\.0%
1 Aurélien Scoubeau 0\.0%
.
.fi
.
.IP "" 0
.
.SH "AUTHOR"
Written by Newell Zhu <\fIzlx\.star@gmail\.com\fR>
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>

200
man/git-line-summary.html Normal file
View file

@ -0,0 +1,200 @@
<!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-line-summary(1) - Show repository summary by line</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="#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-line-summary(1)</li>
<li class='tc'></li>
<li class='tr'>git-line-summary(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>git-line-summary</code> - <span class="man-whatis">Show repository summary by line</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><code>git-line-summary</code></p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Show a summary by line of the repository, rather than by commit like git-summary.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<p> Outputs a repo summary by line.</p>
<pre><code>$ git line-summary
project : git-extras
lines : 16004
authors :
7757 hemanth.hm 48.5%
1019 spacewander 6.4%
916 CJ 5.7%
768 Jonhnny Weslley 4.8%
711 Mark Eissler 4.4%
678 timfeirg 4.2%
474 Ivan Malopinsky 3.0%
387 nickl- 2.4%
368 Tj Holowaychuk 2.3%
337 Paul Schreiber 2.1%
269 Jesús Espino 1.7%
266 wooorm 1.7%
236 Chris Hall 1.5%
217 TJ Holowaychuk 1.4%
205 Leila Muhtasib 1.3%
178 Hemanth.HM 1.1%
107 Niklas Fiekas 0.7%
80 Andy 0.5%
74 soffolk 0.5%
68 Julio Napurí 0.4%
67 Philipp Klose 0.4%
66 Sasha Khamkov 0.4%
66 Nate Jones 0.4%
65 Kenneth Reitz 0.4%
64 Rico Sta. Cruz 0.4%
49 Bruno Sutic 0.3%
36 chernjie 0.2%
35 Titus Wormer 0.2%
35 Michael Komitee 0.2%
33 David Hartmann 0.2%
28 Kevin Woo 0.2%
27 Todd Wolfson 0.2%
22 David Baumgold 0.1%
22 Carl Casbolt 0.1%
18 Ciro Nunes 0.1%
18 Andrew Starr-Bochicchio 0.1%
16 Valérian Galliat 0.1%
16 Riceball LEE 0.1%
16 Damian Krzeminski 0.1%
12 nulltask 0.1%
12 Richard Littauer 0.1%
11 Jesse Sipprell 0.1%
10 meza 0.1%
10 dead-horse 0.1%
9 Kylie McClain 0.1%
9 Camille Reynders 0.1%
8 Jon Ander Peñalba 0.0%
8 Guillaume Seren 0.0%
8 Adam Parkin 0.0%
7 Newell Zhu 0.0%
7 Florian H 0.0%
7 Andre Cerqueira 0.0%
6 zeroDivisible 0.0%
6 Rasmus Wriedt Larsen 0.0%
6 Konstantin Schukraft 0.0%
5 Dan Jackson 0.0%
4 jykntr 0.0%
3 phigoro 0.0%
3 eszabpt 0.0%
3 Raphael Fleischlin 0.0%
3 Curtis McEnroe 0.0%
3 Balazs Nadasdi 0.0%
3 Alex McHale 0.0%
2 Not Committed Yet 0.0%
2 Joshua Appelman 0.0%
2 Evan Grim 0.0%
2 Dave James Miller 0.0%
2 Alexander Krasnukhin 0.0%
2 Aggelos Orfanakos 0.0%
1 Wil Moore III 0.0%
1 TweeKane 0.0%
1 Tony 0.0%
1 Ryan Bohn 0.0%
1 Rob Kennedy 0.0%
1 Phally 0.0%
1 Moritz Grauel 0.0%
1 Jonathan "Duke" Leto 0.0%
1 Jianjin Fan 0.0%
1 Jean Jordaan 0.0%
1 Jan Krueger 0.0%
1 Hogan Long 0.0%
1 Dung Quang 0.0%
1 Brandon Zylstra 0.0%
1 Aurélien Scoubeau 0.0%
</code></pre>
<h2 id="AUTHOR">AUTHOR</h2>
<p>Written by Newell Zhu &lt;<a href="&#109;&#x61;&#x69;&#108;&#116;&#111;&#58;&#x7a;&#108;&#x78;&#46;&#x73;&#x74;&#x61;&#114;&#64;&#x67;&#109;&#x61;&#105;&#x6c;&#46;&#x63;&#x6f;&#x6d;" data-bare-link="true">&#122;&#108;&#x78;&#46;&#x73;&#x74;&#97;&#x72;&#64;&#x67;&#x6d;&#x61;&#x69;&#108;&#x2e;&#99;&#111;&#109;</a>&gt;</p>
<h2 id="REPORTING-BUGS">REPORTING BUGS</h2>
<p>&lt;<a href="https://github.com/tj/git-extras/issues" data-bare-link="true">https://github.com/tj/git-extras/issues</a>&gt;</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p>&lt;<a href="https://github.com/tj/git-extras" data-bare-link="true">https://github.com/tj/git-extras</a>&gt;</p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>May 2015</li>
<li class='tr'>git-line-summary(1)</li>
</ol>
</div>
</body>
</html>

116
man/git-line-summary.md Normal file
View file

@ -0,0 +1,116 @@
git-line-summary(1) -- Show repository summary by line
================================
## SYNOPSIS
`git-line-summary`
## DESCRIPTION
Show a summary by line of the repository, rather than by commit like git-summary.
## EXAMPLES
Outputs a repo summary by line.
$ git line-summary
project : git-extras
lines : 16004
authors :
7757 hemanth.hm 48.5%
1019 spacewander 6.4%
916 CJ 5.7%
768 Jonhnny Weslley 4.8%
711 Mark Eissler 4.4%
678 timfeirg 4.2%
474 Ivan Malopinsky 3.0%
387 nickl- 2.4%
368 Tj Holowaychuk 2.3%
337 Paul Schreiber 2.1%
269 Jesús Espino 1.7%
266 wooorm 1.7%
236 Chris Hall 1.5%
217 TJ Holowaychuk 1.4%
205 Leila Muhtasib 1.3%
178 Hemanth.HM 1.1%
107 Niklas Fiekas 0.7%
80 Andy 0.5%
74 soffolk 0.5%
68 Julio Napurí 0.4%
67 Philipp Klose 0.4%
66 Sasha Khamkov 0.4%
66 Nate Jones 0.4%
65 Kenneth Reitz 0.4%
64 Rico Sta. Cruz 0.4%
49 Bruno Sutic 0.3%
36 chernjie 0.2%
35 Titus Wormer 0.2%
35 Michael Komitee 0.2%
33 David Hartmann 0.2%
28 Kevin Woo 0.2%
27 Todd Wolfson 0.2%
22 David Baumgold 0.1%
22 Carl Casbolt 0.1%
18 Ciro Nunes 0.1%
18 Andrew Starr-Bochicchio 0.1%
16 Valérian Galliat 0.1%
16 Riceball LEE 0.1%
16 Damian Krzeminski 0.1%
12 nulltask 0.1%
12 Richard Littauer 0.1%
11 Jesse Sipprell 0.1%
10 meza 0.1%
10 dead-horse 0.1%
9 Kylie McClain 0.1%
9 Camille Reynders 0.1%
8 Jon Ander Peñalba 0.0%
8 Guillaume Seren 0.0%
8 Adam Parkin 0.0%
7 Newell Zhu 0.0%
7 Florian H 0.0%
7 Andre Cerqueira 0.0%
6 zeroDivisible 0.0%
6 Rasmus Wriedt Larsen 0.0%
6 Konstantin Schukraft 0.0%
5 Dan Jackson 0.0%
4 jykntr 0.0%
3 phigoro 0.0%
3 eszabpt 0.0%
3 Raphael Fleischlin 0.0%
3 Curtis McEnroe 0.0%
3 Balazs Nadasdi 0.0%
3 Alex McHale 0.0%
2 Not Committed Yet 0.0%
2 Joshua Appelman 0.0%
2 Evan Grim 0.0%
2 Dave James Miller 0.0%
2 Alexander Krasnukhin 0.0%
2 Aggelos Orfanakos 0.0%
1 Wil Moore III 0.0%
1 TweeKane 0.0%
1 Tony 0.0%
1 Ryan Bohn 0.0%
1 Rob Kennedy 0.0%
1 Phally 0.0%
1 Moritz Grauel 0.0%
1 Jonathan "Duke" Leto 0.0%
1 Jianjin Fan 0.0%
1 Jean Jordaan 0.0%
1 Jan Krueger 0.0%
1 Hogan Long 0.0%
1 Dung Quang 0.0%
1 Brandon Zylstra 0.0%
1 Aurélien Scoubeau 0.0%
## AUTHOR
Written by Newell Zhu &lt;<zlx.star@gmail.com>&gt;
## REPORTING BUGS
&lt;<https://github.com/tj/git-extras/issues>&gt;
## SEE ALSO
&lt;<https://github.com/tj/git-extras>&gt;

View file

@ -55,6 +55,98 @@ Shows a summary of the repository.
$ git summary v42..
For --line options, you can get result calculate by line rather than commit
$ git summary --line
project : git-extras
lines : 16004
authors :
7757 hemanth.hm 48.5%
1019 spacewander 6.4%
916 CJ 5.7%
768 Jonhnny Weslley 4.8%
711 Mark Eissler 4.4%
678 timfeirg 4.2%
474 Ivan Malopinsky 3.0%
387 nickl- 2.4%
368 Tj Holowaychuk 2.3%
337 Paul Schreiber 2.1%
269 Jesús Espino 1.7%
266 wooorm 1.7%
236 Chris Hall 1.5%
217 TJ Holowaychuk 1.4%
205 Leila Muhtasib 1.3%
178 Hemanth.HM 1.1%
107 Niklas Fiekas 0.7%
80 Andy 0.5%
74 soffolk 0.5%
68 Julio Napurí 0.4%
67 Philipp Klose 0.4%
66 Sasha Khamkov 0.4%
66 Nate Jones 0.4%
65 Kenneth Reitz 0.4%
64 Rico Sta. Cruz 0.4%
49 Bruno Sutic 0.3%
36 chernjie 0.2%
35 Titus Wormer 0.2%
35 Michael Komitee 0.2%
33 David Hartmann 0.2%
28 Kevin Woo 0.2%
27 Todd Wolfson 0.2%
22 David Baumgold 0.1%
22 Carl Casbolt 0.1%
18 Ciro Nunes 0.1%
18 Andrew Starr-Bochicchio 0.1%
16 Valérian Galliat 0.1%
16 Riceball LEE 0.1%
16 Damian Krzeminski 0.1%
12 nulltask 0.1%
12 Richard Littauer 0.1%
11 Jesse Sipprell 0.1%
10 meza 0.1%
10 dead-horse 0.1%
9 Kylie McClain 0.1%
9 Camille Reynders 0.1%
8 Jon Ander Peñalba 0.0%
8 Guillaume Seren 0.0%
8 Adam Parkin 0.0%
7 Newell Zhu 0.0%
7 Florian H 0.0%
7 Andre Cerqueira 0.0%
6 zeroDivisible 0.0%
6 Rasmus Wriedt Larsen 0.0%
6 Konstantin Schukraft 0.0%
5 Dan Jackson 0.0%
4 jykntr 0.0%
3 phigoro 0.0%
3 eszabpt 0.0%
3 Raphael Fleischlin 0.0%
3 Curtis McEnroe 0.0%
3 Balazs Nadasdi 0.0%
3 Alex McHale 0.0%
2 Not Committed Yet 0.0%
2 Joshua Appelman 0.0%
2 Evan Grim 0.0%
2 Dave James Miller 0.0%
2 Alexander Krasnukhin 0.0%
2 Aggelos Orfanakos 0.0%
1 Wil Moore III 0.0%
1 TweeKane 0.0%
1 Tony 0.0%
1 Ryan Bohn 0.0%
1 Rob Kennedy 0.0%
1 Phally 0.0%
1 Moritz Grauel 0.0%
1 Jonathan "Duke" Leto 0.0%
1 Jianjin Fan 0.0%
1 Jean Jordaan 0.0%
1 Jan Krueger 0.0%
1 Hogan Long 0.0%
1 Dung Quang 0.0%
1 Brandon Zylstra 0.0%
1 Aurélien Scoubeau 0.0%
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;

View file

@ -49,3 +49,4 @@ git-summary(1) git-summary
git-touch(1) git-touch
git-undo(1) git-undo
git-unlock(1) git-unlock
git-line-summary(1) git-line-summary