summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorChris Wilson <chris@chris-wilson.co.uk>2009-06-29 23:55:37 +0100
committerChris Wilson <chris@chris-wilson.co.uk>2009-06-29 23:55:37 +0100
commitc081b04b3af47ca35a829bdfb6feb67e6a3dd113 (patch)
tree7ddf2de067329c2eac143a2e5a12ac1d9b56cf7b /README
parentbf0c7f587ca5f564ff78bbc8709df8914c04ad13 (diff)
README: Add initial guidelines
Following a discussion with cworth, set forth a few ideas on how to manage the cairo-traces repository.
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 21 insertions, 0 deletions
diff --git a/README b/README
index c63b9b8..3f18d58 100644
--- a/README
+++ b/README
@@ -15,6 +15,27 @@ against a subset specify a series of traces on the command line and use the
CAIRO_TEST_TARGET environment variable to filter the target. For example,
CAIRO_TEST_TARGET=xlib ./cairo-perf-trace firefox.
+Guidelines
+----------
+Initial thoughts...
+
+1. Nothing obscene, or otherwise unsuitable for viewing by children or in the
+workplace - please be considerate to others. The trace should also respect
+copyright where appropriate. Even though the content is not usually visible
+during a replay, it is not acceptable to distribute such material via
+freedesktop.org.
+
+2. Each trace must be "representative of a significant use". The goal is a
+set of traces that capture the behaviour of real applications during active
+sessions. (We must guard against the tests becoming too artificial as that
+is better served by purpose-written micro-benchmarks.)
+
+3. For practical reasons (i.e. continuous performance testing), each trace
+should neither be profligate in the resources consumed nor the duration of
+the run. However, I'm loathe to exclude tests simply because they take too
+long or can not be run on tiny machines. (Instead, I plan to create subset
+of tests that have been truncated to run within 60s on a 2GHz Intel Core2.)
+
Traces
------
firefox-20090601 - browsing various news site, in particular the