Skip to content

Commit 74678d6

Browse files
authored
minor tweaks to coverage documentation (#258)
1 parent 19fab20 commit 74678d6

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

doc/codeCoverageInstructions.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,14 @@ python build.py
3838
--generator=Ninja ^
3939
--stages=clean,configure,build,install ^
4040
--maya-location <maya_location> ^
41+
--mayausd-location <mayausd_location> ^
4142
--pxrusd-location <pxrusd_location> ^
4243
--devkit-location <devkit_location> ^
4344
--build-args="-DPYTHON_INCLUDE_DIR=<python_include_dir>,-DPython_EXECUTABLE=<python_executable>,-DPYTHON_LIBRARIES=<python_libraries>,-DCMAKE_WANT_MATERIALX_BUILD=ON,-DCMAKE_PREFIX_PATH=<cmake_prefix_path>" ^
4445
<workspace_location>
4546
```
47+
> Note: Some tests might also require `--mtoa-location` or `--lookdevx-location` to succeed.
48+
4649
The `--build-coverage` flag indicates that the variant to be built is the Coverage variant.
4750

4851
At time of writing (February 26th, 2024), only the Ninja code generator is supported. In particular, the Visual Studio generator is known not to output code coverage data.
@@ -84,9 +87,9 @@ llvm-cov show ^
8487
-object="<workspace_dir>\install\Coverage\lib\flowViewport.dll" ^
8588
-show-branches=count ^
8689
-show-regions ^
87-
--ignore-filename-regex='artifactory\\.*' ^
88-
-format=html
89-
-output-dir=<output_dir_name>'
90+
-ignore-filename-regex="artifactory\\.*" ^
91+
-format=html ^
92+
-output-dir=<output_dir_name>
9093
```
9194
Notes:
9295
- `-instr-profile` refers to the previously generated profdata file

0 commit comments

Comments
 (0)