[Piglit] [PATCH 8/8] README: Rework documentation for test classes
Jason Ekstrand
jason at jlekstrand.net
Thu Jun 7 16:03:45 UTC 2018
---
README.md | 56 +++++++++++++++++++++++++++----------------------------
1 file changed, 28 insertions(+), 28 deletions(-)
diff --git a/README.md b/README.md
index dac9ba26b..7259ba574 100644
--- a/README.md
+++ b/README.md
@@ -376,45 +376,45 @@ All new tests must be added to the appropriate profile, all.py profile for
OpenGL and cl.py for OpenCL. There are a few basic test classes supported by the
python framework:
- PiglitBaseTest
- A shared base class for all native piglit tests.
+ - `PiglitBaseTest`
+ A shared base class for all native piglit tests.
- It starts each test as a subprocess, captures stdout and stderr, and waits
- for the test to return.
-
- It provides test timeouts by setting the instances 'timeout' attribute to an
- integer > 0 which is the number of seconds the test should run.
+ It starts each test as a subprocess, captures stdout and stderr, and waits
+ for the test to return.
- It interprets output by reading stdout and looking for 'PIGLIT: ' in the
- output, and then reading any trailing characters as well formed json
- returning the test result.
+ It provides test timeouts by setting the instances 'timeout' attribute to an
+ integer > 0 which is the number of seconds the test should run.
- This is a base class and should not be used directly, but provides an
- explanation of the behavior of the following classes.
+ It interprets output by reading stdout and looking for 'PIGLIT: ' in the
+ output, and then reading any trailing characters as well formed json
+ returning the test result.
- PiglitGLTest
- A test class for native piglit OpenGL tests.
+ This is a base class and should not be used directly, but provides an
+ explanation of the behavior of the following classes.
- In addition to the properties of PiglitBaseTest it provides a mechanism for
- detecting test window resizes and rerunning tests as well as keyword
- arguments for platform requirements.
+ - `PiglitGLTest`
+ A test class for native piglit OpenGL tests.
- PiglitCLTest
- A test class for native piglit OpenCL tests.
+ In addition to the properties of PiglitBaseTest it provides a mechanism for
+ detecting test window resizes and rerunning tests as well as keyword
+ arguments for platform requirements.
- It currently provides no special features.
+ - `PiglitCLTest`
+ A test class for native piglit OpenCL tests.
- GLSLParserTest
- A class for testing a glsl parser.
+ It currently provides no special features.
- It is generally unnecessary to call this class directly as it uses a helper
- function to search directories for tests.
+ - `GLSLParserTest`
+ A class for testing a glsl parser.
- ShaderTest
- A class for testing using OpenGL shaders.
+ It is generally unnecessary to call this class directly as it uses a helper
+ function to search directories for tests.
- It is generally unnecessary to call this class directly as it uses a helper
- function to search directories for tests.
+ - `ShaderTest`
+ A class for testing using OpenGL shaders.
+
+ It is generally unnecessary to call this class directly as it uses a helper
+ function to search directories for tests.
6. Integration
--
2.17.1
More information about the Piglit
mailing list