Mirror
/
gitinspector
mirror of https://github.com/ejwa/gitinspector.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add documentation about JSON output to the AsciiDoc file.

This commit is contained in:
Adam Waldenberg 2015-12-14 05:17:11 +01:00
parent ba049a0367
commit 150e316918
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/gitinspector.txt
View File

@ -22,7 +22,7 @@ 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.
Several output formats are supported, including plain text, HTML, JSON and XML.
OPTIONS
@ -35,7 +35,7 @@ Mandatory arguments to long options are mandatory for short options too. Boolean
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 <<X1,*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 <<X1,*OUTPUT FORMATS*>>)
*--grading*[=BOOL]::
Show statistics and information in a way that is formatted for grading of student projects; this is the same as supplying the options *-HlmrTw*
@ -91,8 +91,11 @@ There are support for multiple output formats in gitinspector. They can be selec
*htmlembedded*::
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.
[[X2]]