mirror of
https://github.com/tj/git-extras.git
synced 2026-09-10 07:26:17 -04:00
c63b46a33b
* Upgrade codespell to v2.4.0
It is a lastet verison, and is needed so that I can use the inline
ignore support in a future commit.
After updating tests/pyproject.toml I ran the following commands:
```
cd tests
poetry lock --no-update
poetry install
```
I also fixed a spelling error in man/git-summary.md, which was not
caught by the old version of codespell. After updating the file I also
updated the related files by running the following commands:
```
cd man
make -C .. man/git-summary.{1,html}
```
* add git-wip and git-unwip
Updated/re-built the documentation with:
```
cd man
make -C .. man/git-unwip.{1,html}
make -C .. man/git-wip.{1,html}
make -C .. man/git-extras.{1,html}
```
144 lines
3.3 KiB
Markdown
144 lines
3.3 KiB
Markdown
git-summary(1) -- Show repository summary
|
|
=========================================
|
|
|
|
## SYNOPSIS
|
|
|
|
`git-summary` [--dedup-by-email] [--no-merges] [<committish>]
|
|
|
|
`git-summary` --line [<path>]
|
|
|
|
## DESCRIPTION
|
|
|
|
Shows a summary of the repository or a path within it.
|
|
|
|
## OPTIONS
|
|
|
|
<committish>
|
|
|
|
Summarize only the range of commits included in the <committish>.
|
|
|
|
<path>
|
|
|
|
Summarize only the range of files included in the <path>.
|
|
|
|
--dedup-by-email
|
|
|
|
Remove duplicate authors who belong to the same email address.
|
|
For example,
|
|
|
|
$ git summary
|
|
...
|
|
133 TJ Holowaychuk 9.9%
|
|
115 Tj Holowaychuk 8.5%
|
|
|
|
$ git summary --dedup-by-email
|
|
...
|
|
248 TJ Holowaychuk 18.4%
|
|
|
|
--no-merges
|
|
|
|
Exclude merge commits.
|
|
|
|
--full-path
|
|
|
|
Show the full path of the repository instead of its directory name.
|
|
|
|
--line
|
|
|
|
Summarize with lines other than commits.
|
|
When `--line` is specified, the last argument is treated as <path>.
|
|
|
|
This option can not be used together with `--dedup-by-email` or `--no-merges`.
|
|
|
|
--output-style <style>
|
|
|
|
Summarizes the repository and print the output according to the specified style.
|
|
Styles:
|
|
* `tabular`: Prints the summary in a tabular form having a header in the
|
|
first line and the values in the second. Column separator is a `|`
|
|
surrounded by at least one space on each side.
|
|
* `oneline`: Prints the summary in a single line. Fields are separated by a `/`
|
|
surrounded by one space on each side.
|
|
|
|
Some information like the authors cannot be displayed in this mode.
|
|
|
|
## EXAMPLES
|
|
|
|
Outputs a repo summary:
|
|
|
|
$ git summary
|
|
|
|
project : express
|
|
repo age : 10 months ago
|
|
branch : master
|
|
last active : 3 weeks ago
|
|
active on : 93 days
|
|
commits : 1893
|
|
files : 111
|
|
uncommitted : 3
|
|
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
|
|
|
|
This command can also take a committish, and will print a summary for the range
|
|
of commits included in the committish:
|
|
|
|
$ git summary v42..
|
|
|
|
Outputs a repo summary by line:
|
|
|
|
$ git summary --line
|
|
|
|
project : git-extras
|
|
lines : 26820
|
|
authors :
|
|
...
|
|
|
|
Filter with the path:
|
|
|
|
$ git summary --line bin/
|
|
|
|
project : git-extras
|
|
lines : 4420
|
|
authors :
|
|
...
|
|
|
|
Tabular summary
|
|
|
|
$ git summary --output-style tabular
|
|
# Repo | Age | Last active | Active on | Commits | Uncommitted | Branch
|
|
git-extras | 13 years | 7 hours ago | 807 days | 1703 | 3 | master
|
|
|
|
Oneline summary
|
|
|
|
$ git summary --output-style oneline
|
|
git-extras / age: 13 years / last active: 7 hours ago / active on 807 days / commits: 1703 / uncommitted: 3 / branch: master
|
|
|
|
## AUTHOR
|
|
|
|
Written by Tj Holowaychuk <<tj@vision-media.ca>>
|
|
|
|
## REPORTING BUGS
|
|
|
|
<<https://github.com/tj/git-extras/issues>>
|
|
|
|
## SEE ALSO
|
|
|
|
<<https://github.com/tj/git-extras>>
|