Skip to content

GitStat converter documentation #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open

GitStat converter documentation #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions toolchain/converter/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ To build a city with separated directories, the following command should be give

`java -jar converter.jar -t sonarqube -i <serverName> -o <outputFilename> -p projects=<projectname> splitDirs=true`

# GitStats CDF converter

This application scans and retrieves usable statistic information from the GitStats git repository statistics generator. It uses the gitstats as type to parse the html and dat files from the given input folder.

**Usage**: `java -jar converter.jar -t <type> -i <input path> [-o <output.xml>]`

* `-i`: input, the path of the folder generated by GitStats. Required.
* `-o`: output, the path of the output XML file. Optional.
* `-t`: type, the type of the conversion. In this case it will be ‘gitstats’. Required.

After execution the tool will generate a Converter output xml which contains git statistics elements like line of code, commits, committed files group by extension with properties of dates.


# About the output XML

The output XML contains the name and the type of the elements and the properties of them.
Expand Down