From: Erik Faye-Lund Date: Thu, 20 Oct 2022 07:47:18 +0000 (+0200) Subject: docs: skqp -> SkQP X-Git-Tag: upstream/22.3.5~1104 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=af3c1a960ccdbb30db3b65db31f1ebed16916d29;p=platform%2Fupstream%2Fmesa.git docs: skqp -> SkQP This seems to be the official styling of the name. Reviewed-by: David Heidelberg Part-of: --- diff --git a/docs/ci/skqp.rst b/docs/ci/skqp.rst index 92ea574..4345ed9 100644 --- a/docs/ci/skqp.rst +++ b/docs/ci/skqp.rst @@ -1,7 +1,7 @@ -skqp +SkQP ==== -`skqp `_ stands for SKIA Quality +`SkQP `_ stands for SKIA Quality Program conformance tests. Basically, it has sets of rendering tests and unit tests to ensure that `SKIA `_ is meeting its design specifications on a specific device. @@ -17,7 +17,7 @@ Render tests design ^^^^^^^^^^^^^^^^^^^ It is worth noting that `rendertests.txt` can bring some detail about each test -expectation, so each test can have a max pixel error count, to tell skqp that it +expectation, so each test can have a max pixel error count, to tell SkQP that it is OK to have at most that number of errors for that test. See also: https://github.com/google/skia/blob/c29454d1c9ebed4758a54a69798869fa2e7a36e0/tools/skqp/README_ALGORITHM.md @@ -27,7 +27,7 @@ Location ^^^^^^^^ Each `rendertests.txt` and `unittest.txt` file must be located inside a specific -subdirectory inside skqp assets directory. +subdirectory inside SkQP assets directory. +--------------+--------------------------------------------+ | Test type | Location | @@ -67,28 +67,28 @@ Example file .. _rendertests-design: -skqp reports +SkQP reports ------------ -skqp generates reports after finishing its execution, they are located at the job +SkQP generates reports after finishing its execution, they are located at the job artifacts results directory and are divided in subdirectories by rendering tests backends and unit tests. The job log has links to every generated report in order to facilitate -the skqp debugging. +the SkQP debugging. -Maintaining skqp on Mesa CI +Maintaining SkQP on Mesa CI --------------------------- -skqp is built alongside with another binary, namely `list_gpu_unit_tests`, it is +SkQP is built alongside with another binary, namely `list_gpu_unit_tests`, it is located in the same folder where `skqp` binary is. This binary will generate the expected `unittests.txt` for the target GPU, so -ideally it should be executed on every skqp update and when a new device -receives skqp CI jobs. +ideally it should be executed on every SkQP update and when a new device +receives SkQP CI jobs. 1. Generate target unit tests for the current GPU with :code:`./list_gpu_unit_tests > unittests.txt` -2. Run skqp job +2. Run SkQP job 3. If there is a failing or crashing unit test, remove it from the corresponding `unittests.txt`