Added code coverage documentation. #70
Conversation
doc/codeCoverageInstructions.md
Outdated
| To build the coverage variant you can run: | ||
|
|
||
| ``` | ||
| python build.py --generator=Ninja --stages clean,configure,build,install --maya-location <maya_location> --build-coverage --pxrusd-location <pxrusd_location> --devkit-location <devkit_location> --build-args="-DPYTHON_INCLUDE_DIR=<python_include_dir>,-DPython_EXECUTABLE=<python_executable>,-DPYTHON_LIBRARIES=<python_libraries>,-DBUILD_WITH_PYTHON_3=ON,-DBUILD_WITH_PYTHON_3_VERSION=<version_of_python>,-DQT_VERSION=6.5.0,-DCMAKE_WANT_MATERIALX_BUILD=ON,-DCMAKE_PREFIX_PATH=<cmake_prefix_path>" <installation_location> |
There was a problem hiding this comment.
Should we refer to the build doc here? Regardless, we could simplify the example slightly :
BUILD_WITH_PYTHON_3no longer existsBUILD_WITH_PYTHON_3_VERSIONis optional, by default automatically determined based on the Maya versionQT_VERSION: not sure if this is even actually used (the CMake script usesWANT_QT_VERSION), but in any case, it is not required, as the Qt version to use is also automatically determined based on the Maya version
Same goes for the other example below
There was a problem hiding this comment.
Thanks for the doc! I was able to generate and view the HTML report. I did get a warning: 63 functions have mismatched data when running the llvm-cov command, is that expected? The report looks fine to me and I can navigate individual files, so not sure what that's about
I get the same, but I haven't figured out which functions are involved. Appears to be a bug with llvm-cov for dynamic libraries, possibly all platform: |
ppt-adsk
added
the
ready-for-merge
Provide documentation on Windows code coverage using clang / LLVM.