Skip to content

Commit 781b1ab

Browse files
committed
Update to docs
1 parent ffcbfb0 commit 781b1ab

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -27,16 +27,17 @@ The python scrip `vcast_exec.py` is the main driver for build/execute VectorCAST
2727
The api for vcast_exec.py follows:
2828

2929
```
30+
vpython vcast_exec.py --help
3031
usage: vcast_exec.py [-h] [--build-execute] [--build | --incremental] [--output_dir OUTPUT_DIR]
31-
[--source_root SOURCE_ROOT] [--html_base_dir HTML_BASE_DIR]
32-
[--cobertura] [--cobertura_extended] [--lcov] [--junit]
32+
[--source_root SOURCE_ROOT] [--html_base_dir HTML_BASE_DIR]
33+
[--cobertura] [--cobertura_extended] [--lcov] [--junit]
3334
[--export_rgw] [--sonarqube] [--pclp_input PCLP_INPUT]
34-
[--pclp_output_html PCLP_OUTPUT_HTML]
35-
[--exit_with_failed_count [EXIT_WITH_FAILED_COUNT]] [--aggregate]
36-
[--metrics] [--fullstatus] [--tcmr] [--jobs JOBS]
37-
[--ci] [-l LEVEL] [-e ENVIRONMENT] [--gitlab | --azure]
38-
[--print_exc] [--timing] [--verbose] [--version]
39-
ManageProject
35+
[--pclp_output_html PCLP_OUTPUT_HTML]
36+
[--exit_with_failed_count [EXIT_WITH_FAILED_COUNT]]
37+
[--aggregate] [--metrics] [--fullstatus] [--utfull] [--tcmr] [--index]
38+
[--jobs JOBS] [--ci] [--level LEVEL] [--environment ENVIRONMENT]
39+
[--gitlab | --azure] [--print_exc] [--timing] [--version]
40+
[ManageProject]
4041
4142
positional arguments:
4243
ManageProject VectorCAST Project Name
@@ -67,21 +68,21 @@ The api for vcast_exec.py follows:
6768
--export_rgw Export RGW data
6869
--sonarqube Generate test results in SonarQube Generic test execution report format (CppUnit)
6970
--pclp_input PCLP_INPUT
70-
Generate static analysis results from PC-lint Plus XML file to generic static
71-
analysis format (codequality)
71+
Generate static analysis results from PC-lint Plus XML file to generic static analysis format (codequality)
7272
--pclp_output_html PCLP_OUTPUT_HTML
7373
Generate static analysis results from PC-lint Plus XML file to an HTML output
7474
--exit_with_failed_count [EXIT_WITH_FAILED_COUNT]
75-
Returns failed test case count as script exit. Set a value to indicate a percentage
76-
above which the job will be marked as failed
75+
Returns failed test case count as script exit. Set a value to indicate a percentage above which the job will be marked as failed
7776
7877
Report Selection:
7978
VectorCAST Manage reports that can be generated
8079
8180
--aggregate Generate aggregate coverage report VectorCAST Project
8281
--metrics Generate metrics reports for VectorCAST Project
8382
--fullstatus Generate full status reports for VectorCAST Project
83+
--utfull Generate Full Reports for each VectorCAST environment in project
8484
--tcmr Generate Test Cases Management Reports for each VectorCAST environment in project
85+
--index Generate an index.html report that ties all the other HTML reports together
8586
8687
Build/Execution Options:
8788
Options that effect build/execute operation
@@ -101,10 +102,14 @@ The api for vcast_exec.py follows:
101102
--print_exc Prints exceptions
102103
--timing Prints timing information for metrics generation
103104
-v, --verbose Enable verbose output
104-
--version Diplays the version of the script.
105+
--version Displays the version information
105106
```
106107

107108
# Change log
109+
8/2025
110+
* Add unit test Full Report creation
111+
* Updated index.html to be more readable
112+
108113
7/2025
109114
* Updated to produce a version of the script (--version) based on push date and commit ID
110115

0 commit comments

Comments
 (0)