diff --git a/docs/gitinspector.1 b/docs/gitinspector.1 index 9302580..e268c5e 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: 10/12/2015 +.\" Date: 12/14/2015 .\" Manual: The gitinspector Manual .\" Source: gitinspector 0.4.2 .\" Language: English .\" -.TH "GITINSPECTOR" "1" "10/12/2015" "gitinspector 0\&.4\&.2" "The gitinspector Manual" +.TH "GITINSPECTOR" "1" "12/14/2015" "gitinspector 0\&.4\&.2" "The gitinspector Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -36,7 +36,7 @@ gitinspector \- statistical analysis tool for git repositories .sp 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\&. .sp -Several output formats are supported, including plain text, HTML and XML\&. +Several output formats are supported, including plain text, HTML, JSON and XML\&. .SH "OPTIONS" .sp 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\&. @@ -56,7 +56,7 @@ asterisk characters includes all files regardless of extension\&. .RS 4 Defines in which format output should be generated; the default format is \fItext\fR -and the available formats are: html,htmlembedded,text,xml (see +and the available formats are: html,htmlembedded,json,text,xml (see \fBOUTPUT FORMATS\fR) .RE .PP @@ -128,11 +128,11 @@ Output version information and exit .RE .SH "OUTPUT FORMATS" .sp -There are support for multiple output formats in gitinspector\&. They can be selected using the \fB\-F\fR/\fB\-\-format\fR flags when running the main gitinspector script\&. +There is support for multiple output formats in gitinspector\&. They can be selected using the \fB\-F\fR/\fB\-\-format\fR flags when running the main gitinspector script\&. .PP \fBtext (plain text)\fR .RS 4 -Plain text with some very simple ANSI formatting, suitable for console output\&. This is the format chosen by default by gitinspector\&. +Plain text with some very simple ANSI formatting, suitable for console output\&. This is the format chosen by default in gitinspector\&. .RE .PP \fBhtml\fR @@ -145,9 +145,14 @@ HTML with external links\&. The generated HTML page links to some external resou HTML with no external links\&. Similar to the HTML output format, but requires no active internet connection\&. As a consequence; the generated pages are bigger (as certain scripts have to be embedded into the generated output)\&. .RE .PP +\fBjson\fR +.RS 4 +JSON suitable for machine consumption\&. If you want to parse the output generated by gitinspector in a script or application of your own; this format is suitable\&. +.RE +.PP \fBxml\fR .RS 4 -XML suitable for machine consumption\&. If you want to parse the output generated by gitinspector in a script or application of your own; this is the format you should choose\&. +XML suitable for machine consumption\&. If you want to parse the output generated by gitinspector in a script or application of your own; this format is suitable\&. .RE .SH "FILTERING" .sp @@ -279,7 +284,7 @@ Sometimes, sub\-string matching (as described above) is simply not enough\&. The .RE .SH "USING GIT TO CONFIGURE GITINSPECTOR" .sp -Options in gitinspector can be set using \fBgit config\fR\&. 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)\&. +Options in gitinspector can be set using \fBgit config\fR\&. 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 configured via git config (and take the same arguments)\&. .sp To configure how gitinspector should behave in all git repositories, execute the following git command: .sp diff --git a/docs/gitinspector.html b/docs/gitinspector.html index 583fe8e..dbfa239 100644 --- a/docs/gitinspector.html +++ b/docs/gitinspector.html @@ -1,12 +1,12 @@ -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, JSON 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. 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 OUTPUT FORMATS) + Defines in which format output should be generated; the default format is text and the available formats are: html,htmlembedded,json,text,xml (see OUTPUT FORMATS)
--grading[=BOOL]
@@ -59,10 +59,10 @@ --version
Output version information and exit -

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.

+

OUTPUT FORMATS

There is 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)
- Plain text with some very simple ANSI formatting, suitable for console output. This is the format chosen by default by gitinspector. + Plain text with some very simple ANSI formatting, suitable for console output. This is the format chosen by default in gitinspector.
html
@@ -72,9 +72,13 @@
HTML with no external links. Similar to the HTML output format, but requires no active internet connection. As a consequence; the generated pages are bigger (as certain scripts have to be embedded into the generated output).
+json +
+ JSON suitable for machine consumption. If you want to parse the output generated by gitinspector in a script or application of your own; this format is suitable. +
xml
- XML suitable for machine consumption. If you want to parse the output generated by gitinspector in a script or application of your own; this is the format you should choose. + XML suitable for machine consumption. If you want to parse the output generated by gitinspector in a script or application of your own; this format is suitable.

FILTERING

gitinspector offers several different ways of filtering out unwanted information from the generated statistics:

  • gitinspector -x myfile, filter out and exclude statistics from all files (or paths) with the string "myfile"
  • @@ -97,5 +101,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

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

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 configured 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 36a5029..c23c7df 100644 Binary files a/docs/gitinspector.pdf and b/docs/gitinspector.pdf differ diff --git a/docs/gitinspector.txt b/docs/gitinspector.txt index f03250b..1c7808b 100644 --- a/docs/gitinspector.txt +++ b/docs/gitinspector.txt @@ -80,10 +80,10 @@ Mandatory arguments to long options are mandatory for short options too. Boolean [[X1]] 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. +There is 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)*:: - Plain text with some very simple ANSI formatting, suitable for console output. This is the format chosen by default by gitinspector. + Plain text with some very simple ANSI formatting, suitable for console output. This is the format chosen by default in gitinspector. *html*:: HTML with external links. The generated HTML page links to some external resources; such as the JavaScript library JQuery. It requires an active internet connection to properly function. This output format will most likely also link to additional external resources in the future. @@ -124,7 +124,7 @@ Sometimes, sub-string matching (as described above) is simply not enough. Theref 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). +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 configured via git config (and take the same arguments). To configure how gitinspector should behave in all git repositories, execute the following git command: