Skip to content

Commit

Permalink
Update docs #3338
Browse files Browse the repository at this point in the history
  • Loading branch information
Nereboss committed Nov 21, 2023
1 parent 52b5320 commit f54bcb2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
7 changes: 4 additions & 3 deletions analysis/import/SourceCodeParser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ or
or

```
./ccsh sourcecodeparser src/test/resources -o foo.cc.json --default-excludes -e=something -e=/.*\.foo -f=table
./ccsh sourcecodeparser src/test/resources -o foo.cc.json --default-excludes -e=something -e=/.*\.foo -f=csv
```

or

```
./ccsh sourcecodeparser src/test/resources -o foo.cc.json -f=table -i
./ccsh sourcecodeparser src/test/resources -o foo.cc.json -f=csv -i
```

If a project is piped into the SourceCodeParser, the results and the piped project are merged.
Expand All @@ -56,9 +56,10 @@ The resulting project has the project name specified for the SourceCodeParser.

- --default-excludes (exclude build, target, dist and out folders as well as files/folders starting with '.')
- -e, --exclude=\<excludePattern> (exclude file/folder from scan according to regex pattern)
- -f, --format=\<outputFormat> (table or json)
- -f, --format=\<outputFormat> (csv or json)
- -h, --help
- -i, --no-issues (do not search for sonar issues)
- -nc, --not-compressed (save uncompressed output file)
- -o, --output-file=\<outputFile> (file to write output to, if empty stdout is used)
- -v, --verbose

Expand Down
2 changes: 1 addition & 1 deletion gh-pages/_docs/04-02-sourcecodeparser.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The Source-Code-Parser is parser to generate code metrics from a source code fil
| `-h, --help` | displays help |
| `-i, --no-issues` | do not search for sonar issues |
| `-o, --outputFile=<outputFile>` | output File (or empty for stdout) |
| `-nc, --not-compressed` | uncompresses outputfile to json format, if format of File is gzip |
| `-nc, --not-compressed` | save uncompressed output file (instead of gzip) |
| `-v, --verbose` | display info messages from sonar plugin |

### Usage
Expand Down

0 comments on commit f54bcb2

Please sign in to comment.