summaryrefslogtreecommitdiffstats
path: root/testing/runtimes/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'testing/runtimes/README.md')
-rw-r--r--testing/runtimes/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/testing/runtimes/README.md b/testing/runtimes/README.md
new file mode 100644
index 000000000..4821f01d5
--- /dev/null
+++ b/testing/runtimes/README.md
@@ -0,0 +1,19 @@
+Test Runtimes
+=============
+
+These files contain test runtimes for various suites across different platforms. Each JSON file
+corresponds to a single test job in production and has the following format:
+
+ { '<test id>': <average runtime> }
+
+These files are being used to normalize chunk durations so all chunks take roughly the same length
+of time. They are still experimental and their format and/or file structure are subject to change
+without notice.
+
+Generating a Test Runtime File
+------------------------------
+
+The writeruntimes.py script can be used to generate a runtime file. You must
+specify the suite for which the runtimes are to be generated, e.g.
+
+ writeruntimes.py -s mochitest-media