tj.git-extras/man/git-summary.1
Nicolai Skogheim 7fbe00c311 summary docs: Remove --line example
Since using --line only makes git-summary call git-line-summary
the example is redundant. It is also somewhat smelly to document
other functions than it's own like that.
2015-08-07 08:36:55 +02:00

86 lines
1.5 KiB
Groff

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "GIT\-SUMMARY" "1" "August 2015" "" "Git Extras"
.
.SH "NAME"
\fBgit\-summary\fR \- Show repository summary
.
.SH "SYNOPSIS"
\fBgit\-summary\fR [\-\-line] [<commitish>]
.
.SH "DESCRIPTION"
Shows a summary of the repository\.
.
.SH "OPTIONS"
<commitish>
.
.P
Summarize only the range of commits included in the <commitish>\.
.
.P
\-\-line
.
.P
Summarize with lines other than commits\. This actually just results in a call to \fBgit\-line\-summary\fR(1)\. Any <commitish> is ignored when \-\-line is specified\. See \fBgit\-line\-summary\fR(1) for more info\.
.
.SH "EXAMPLES"
Outputs a repo summary:
.
.IP "" 4
.
.nf
$ git summary
project : express
repo age : 10 months ago
commits : 1893
active : 93 days
files : 111
authors :
1285 visionmedia
478 Tj Holowaychuk
48 Aaron Heckmann
34 csausdev
26 ciaranj
6 Guillermo Rauch
3 Nick Poulden
2 Brian McKinney
2 Benny Wong
1 Justin Lilly
1 James Herdman
1 Adam Sanderson
1 Viktor Kelemen
1 Gregory Ritter
1 Greg Ritter
1 ewoudj
1 isaacs
1 Matt Colyer
.
.fi
.
.IP "" 0
.
.P
This command can also take a commitish, and will print a summary for the range of commits included in the commitish:
.
.IP "" 4
.
.nf
$ git summary v42\.\.
.
.fi
.
.IP "" 0
.
.SH "AUTHOR"
Written by Tj Holowaychuk <\fItj@vision\-media\.ca\fR>
.
.SH "REPORTING BUGS"
<\fIhttps://github\.com/tj/git\-extras/issues\fR>
.
.SH "SEE ALSO"
<\fIhttps://github\.com/tj/git\-extras\fR>