|GITINSPECTOR(1)||The gitinspector Manual||GITINSPECTOR(1)|
NAME¶gitinspector - statistical analysis tool for git repositories
SYNOPSIS¶gitinspector [OPTION]... [REPOSITORY]
DESCRIPTION¶Analyze and gather statistics about a git repository. The defaut analysis shows general statistics per author, which can be complemented with a timeline analysis that shows the workload and activity of each author. Under normal operation, gitinspector filters the results to only show statistics about a number of given extensions and by default only includes source files in the statistical analysis.
Several output formats are supported, including plain text, HTML and XML.
OPTIONS¶List information about the repository in REPOSITORY. If no repository is specified, the current directory is used. If multiple repositories are given, information will be fetched from the last repository specified.
Mandatory arguments to long options are mandatory for short options too. Boolean arguments can only be given to long options.
OUTPUT FORMATS¶There are support for multiple output formats in gitinspector. They can be selected using the -F/--format flags when running the main gitinspector script.
text (plain text)
FILTERING¶gitinspector offers several different ways of filtering out unwanted information from the generated statistics:
The gitinspector command also lets you add multiple filtering rules by simply specifying the -x options several times or by separating each filtering rule with a comma;
Sometimes, sub-string matching (as described above) is simply not enough. Therefore, gitinspector let’s you specify regular expressions as filtering rules. This makes filtering much more flexible:
USING GIT TO CONFIGURE GITINSPECTOR¶Options in gitinspector can be set using git config. Consequently, it is possible to configure gitinspector behavior globally (in all git repositories) or locally (in a specific git repository). It also means that settings will be permanently stored. All the long options that can be given to gitinspector can also be configure via git config (and take the same arguments).
To configure how gitinspector should behave in all git repositories, execute the following git command:
git config --global inspector.option setting
To configure how gitinspector should behave in a specific git repository, execute the following git command (with the current directory standing inside the repository in question):
git config inspector.option setting
AUTHOR¶Originally written by Adam Waldenberg.
REPORTING BUGS¶Report gitinspector bugs to firstname.lastname@example.org
The gitinspector project page: https://github.com/ejwa/gitinspector
If you encounter problems, be sure to read the FAQ first: https://github.com/ejwa/gitinspector/wiki/FAQ
There is also an issue tracker at: https://github.com/ejwa/gitinspector/issues
COPYRIGHT¶Copyright © 2012-2016 Ejwa Software. All rights reserved. License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.