diff --git a/docs/gitinspector.1 b/docs/gitinspector.1 index bf9aecb..7345a3e 100644 --- a/docs/gitinspector.1 +++ b/docs/gitinspector.1 @@ -2,12 +2,12 @@ .\" Title: gitinspector .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/24/2015 +.\" Date: 10/01/2015 .\" Manual: The gitinspector Manual -.\" Source: gitinspector 0.4.0 +.\" Source: gitinspector 0.4.2dev .\" Language: English .\" -.TH "GITINSPECTOR" "1" "08/24/2015" "gitinspector 0\&.4\&.0" "The gitinspector Manual" +.TH "GITINSPECTOR" "1" "10/01/2015" "gitinspector 0\&.4\&.2dev" "The gitinspector Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,7 +45,11 @@ Mandatory arguments to long options are mandatory for short options too\&. Boole .PP \fB\-f, \-\-file\-types\fR=EXTENSIONS .RS 4 -A comma separated list of file extensions to include when computing statistics\&. The default extensions used are: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql +A comma separated list of file extensions to include when computing statistics\&. The default extensions used are: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql\&. Specifying a single +\fI*\fR +asterisk character includes files with no extension\&. Specifying two consecutive +\fI**\fR +asterisk characters includes all files regardless of extension\&. .RE .PP \fB\-F, \-\-format\fR=FORMAT @@ -204,6 +208,17 @@ gitinspector offers several different ways of filtering out unwanted information \fBgitinspector \-x revision:8755fb33\fR, filter out and exclude statistics from all revisions containing the hash "8755fb33" .RE .sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +\fBgitinspector \-x message:BUGFIX\fR, filter out and exclude statistics from all revisions containing "BUGFIX" in the commit message\&. +.RE +.sp 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; .sp .RS 4 @@ -283,6 +298,8 @@ Report gitinspector bugs to gitinspector@ejwa\&.se The gitinspector project page: https://github\&.com/ejwa/gitinspector .sp If you encounter problems, be sure to read the FAQ first: https://github\&.com/ejwa/gitinspector/wiki/FAQ +.sp +There is also an issue tracker at: https://github\&.com/ejwa/gitinspector/issues .SH "COPYRIGHT" .sp Copyright \(co 2012\-2015 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\&. diff --git a/docs/gitinspector.html b/docs/gitinspector.html index 881cc35..8be30b1 100644 --- a/docs/gitinspector.html +++ b/docs/gitinspector.html @@ -1,8 +1,8 @@ -gitinspector

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.

+gitinspector

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.

-f, --file-types=EXTENSIONS
- A comma separated list of file extensions to include when computing statistics. The default extensions used are: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql + A comma separated list of file extensions to include when computing statistics. The default extensions used are: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql. Specifying a single * asterisk character includes files with no extension. Specifying two consecutive ** asterisk characters includes all files regardless of extension.
-F, --format=FORMAT
@@ -85,6 +85,8 @@ gitinspector -x email:@gmail.com, filter out and exclude statistics from all authors with a gmail account
  • gitinspector -x revision:8755fb33, filter out and exclude statistics from all revisions containing the hash "8755fb33" +
  • +gitinspector -x message:BUGFIX, filter out and exclude statistics from all revisions containing "BUGFIX" in the commit message.

    • 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;

    • gitinspector -x author:John -x email:@gmail.com
    • @@ -95,5 +97,5 @@ gitinspector -x "author:\^(?!([A-C]))", only show statistics from authors starting with the letters A/B/C
    • gitinspector -x "email:.com$", filter out statistics from all email addresses ending with ".com" -

    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 gitinspector@ejwa.se

    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

    COPYRIGHT

    Copyright © 2012-2015 Ejwa Software. All rights reserved. License GPLv3+: GNU GPL version 3 or later http://gnu.org/licenses/gpl.html. +

    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 gitinspector@ejwa.se

    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-2015 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.

    SEE ALSO

    git(1)

    \ No newline at end of file diff --git a/docs/gitinspector.pdf b/docs/gitinspector.pdf index 1d0a7d1..55865e3 100644 Binary files a/docs/gitinspector.pdf and b/docs/gitinspector.pdf differ diff --git a/docs/gitinspector.txt b/docs/gitinspector.txt index c806a58..d5937a1 100644 --- a/docs/gitinspector.txt +++ b/docs/gitinspector.txt @@ -3,7 +3,7 @@ GITINSPECTOR(1) =============== :doctype: manpage -:man version: 0.4.0 +:man version: 0.4.2dev :man source: gitinspector :man manual: The gitinspector Manual @@ -32,7 +32,7 @@ List information about the repository in REPOSITORY. If no repository is specifi Mandatory arguments to long options are mandatory for short options too. Boolean arguments can only be given to long options. *-f, --file-types*=EXTENSIONS:: - A comma separated list of file extensions to include when computing statistics. The default extensions used are: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql + A comma separated list of file extensions to include when computing statistics. The default extensions used are: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql. Specifying a single '\*' asterisk character includes files with no extension. Specifying two consecutive '**' asterisk characters includes all files regardless of extension. *-F, --format*=FORMAT:: Defines in which format output should be generated; the default format is 'text' and the available formats are: html,htmlembedded,text,xml (see <>) @@ -105,6 +105,7 @@ gitinspector offers several different ways of filtering out unwanted information * *gitinspector -x author:John*, filter out and exclude statistics from all authors containing the string "John" * *gitinspector -x email:@gmail.com*, filter out and exclude statistics from all authors with a gmail account * *gitinspector -x revision:8755fb33*, filter out and exclude statistics from all revisions containing the hash "8755fb33" +* *gitinspector -x message:BUGFIX*, filter out and exclude statistics from all revisions containing "BUGFIX" in the commit message. 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; @@ -144,6 +145,8 @@ The gitinspector project page: If you encounter problems, be sure to read the FAQ first: +There is also an issue tracker at: + COPYRIGHT --------- Copyright (C) 2012-2015 Ejwa Software. All rights reserved. License GPLv3+: GNU GPL version 3 or later . diff --git a/gitinspector/help.py b/gitinspector/help.py index ad7b337..9ddc5c8 100644 --- a/gitinspector/help.py +++ b/gitinspector/help.py @@ -34,6 +34,8 @@ Boolean arguments can only be given to long options. include when computing statistics. The default extensions used are: {1} + Specifying * includes files with no + extension, while ** includes all files -F, --format=FORMAT define in which format output should be generated; the default format is 'text' and the available formats are: