[Piglit] [Patch V2 6/6] environment.py: Add docstrings
Dylan Baker
baker.dylan.c at gmail.com
Mon Jan 13 15:09:37 PST 2014
This patch adds docstrings to the remaining places that are needed.
Signed-off-by: Dylan Baker <baker.dylan.c at gmail.com>
---
framework/environment.py | 15 +++++++++++++++
1 file changed, 15 insertions(+)
diff --git a/framework/environment.py b/framework/environment.py
index 0ff2055..c40f813 100644
--- a/framework/environment.py
+++ b/framework/environment.py
@@ -15,6 +15,8 @@
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+""" Module for viewing and modifying the testing environment """
+
import os
import os.path as path
@@ -46,6 +48,19 @@ if 'MESA_DEBUG' not in os.environ:
class Environment:
+ """ Object cointaining the piglit testing environment
+
+ Keyword Arguments:
+ concurrent -- run tests concurrently or serially. default: True
+ execute -- run tests or only simulate running tests. default: True
+ include_filter -- a list of strigs which will be compiled to regex. Only
+ tests matching these strings will be run. default: []
+ exclude_filter -- a list of strigs which will be compiled to regex. Tests
+ matching these will not be run. default: []
+ valgrind -- Run valgrind on tests. default: False
+ dmesg -- check dmesg for failures. default: False
+
+ """
def __init__(self, concurrent=True, execute=True, include_filter=[],
exclude_filter=[], valgrind=False, dmesg=False):
self.concurrent = concurrent
--
1.8.5.2
More information about the Piglit
mailing list