aboutsummaryrefslogtreecommitdiff
path: root/crosperf/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'crosperf/README.md')
-rw-r--r--crosperf/README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/crosperf/README.md b/crosperf/README.md
new file mode 100644
index 00000000..18601b67
--- /dev/null
+++ b/crosperf/README.md
@@ -0,0 +1,45 @@
+# experiment_files
+
+To use these experiment files, replace the board, remote and images
+placeholders and run crosperf on them.
+
+Further information about crosperf:
+https://sites.google.com/a/google.com/chromeos-toolchain-team-home2/home/team-tools-and-scripts/crosperf-cros-image-performance-comparison-tool
+
+The final experiment file should look something like the following (but with
+different actual values for the fields):
+
+```
+board: lumpy
+remote: 123.45.67.089
+
+# Add images you want to test:
+
+my_image {
+ chromeos_image: /usr/local/chromeos/src/build/images/lumpy/chromiumos_test_image.bin
+}
+
+vanilla_image {
+ chromeos_root: /usr/local/chromeos
+ build: lumpy-release/R35-5672.0.0
+}
+
+# Paste experiment benchmarks here. Example, I pasted
+# `page_cycler_v2.morejs` here.
+
+# This experiment just runs a short autotest which measures the performance
+# of Telemetry's `page_cycler_v2.morejs`. In addition, it profiles cycles.
+
+perf_args: record -e cycles
+
+benchmark: page_cycler_v2.morejs {
+ suite: telemetry_Crosperf
+ iterations: 1
+}
+```
+
+# default_remotes
+
+This is the list of machines allocated for toolchain team.
+This should be kept in sync with:
+https://chromeos-swarming.appspot.com/botlist?c=id&c=task&c=label-board&c=label-pool&c=os&c=status&d=asc&f=label-pool%3Atoolchain&k=label-pool&s=id