Skip to content

Improve documentation for running unit tests #1868

@doug-walker

Description

@doug-walker

The documentation on Contributing has some basic information about running the unit tests. However, it would be helpful to extend that to cover situations such as:

  • Running individual tests rather than all tests
  • Running only the CPU, GPU, or Python tests rather than all tests

For example, this will run only the CPU unit tests from the Builtins suite:
tests/cpu/test_cpu_exec --run_only Builtins

And this will run just Python test:
python3 ../tests/python/OpenColorIOTestSuite.py $PWD

Metadata

Metadata

Labels

DocumentationDocumentation related development and/or updates.devdays25good first issueStandard label for new developers to locate good issues to tackle to learn about OCIO development.help wantedIssues that the TSC has decided are worth implementing, but don't currently have the dev resources.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions