config: README annotate

annotate README @ 198:59d4f04497dd

package into extension for profile, add direct file logging instead of stdout r=vlad

author	Joel Maher <jmaher@mozilla.com>
date	Tue, 05 Oct 2010 17:01:29 -0400
parents	dd0018bc27de
children

rev	line source
196 dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	1 Pageload Test Component
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	2 =======================
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	3
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	4 Usage:
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	5
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	6 ./firefox -tp file:///path/to/manifest.txt [-tpargs...]
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	7
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	8 See ./firefox -help for other arguments.
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	9
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	10
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	11 Manifest file format
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	12 ====================
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	13
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	14 Comments in the manifest file start with a #. Each line may be:
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	15
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	16 * a URL (absolute or relative to the manifest)
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	17
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	18 This URL is added to the list of tests.
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	19
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	20 * one or more flags, followed by whitespace, followed by a URL
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	21
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	22 The only flag supported currently is '%', which indicates that
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	23 a test will do its own timing. (See Self-timing Tests below.)
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	24
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	25 * "include" followed by whitespace, followed by a URL
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	26
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	27 Parse the given manifest file.
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	28
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	29 Self-timing Tests
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	30 =================
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	31
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	32 Most timing tests are interested in timing how long it takes the page
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	33 to load; that is, from the start of page loading until the 'load'
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	34 event is dispatched. By default, this is what the pageloader will
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	35 time. However, if a test URL has the % flag, the test is expected to
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	36 report its own timing. For this purpose, the pageloader will provide
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	37 a function named "tpRecordTime" in the test's global object that it
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	38 should call once it has performed whatever timing it wants to do.
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	39 The given value will be used as the timing result for this test.
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	40
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	41 Output format
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	42 =============
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	43
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	44 The result is a dump to stdout via dump() --
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	45 browser.dom.window.dump.enabled must be set to true in the profile. A
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	46 number of output formats can be specified via the -tpformat command
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	47 line option, currently 'js', 'text', and 'tinderbox' are supported.
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	48
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	49 Sample 'js' format output:
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	50
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	51 ([({page:"1280x1024-PNG/index.html", value:133, stddev:20.049937655763422}),({page:"bugzilla.mozilla.org/index.html", value:233, stddev:36.66606060105176}),({page:"espn.go.com/index.html", value:117.6, stddev:1.2}),({page:"home.netscape.com/index.html", value:97.8, stddev:47.41898354035017}),])
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	52
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	53 Sample 'text' format output:
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	54
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	55 ============================================================
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	56 Page mean stdd min max raw
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	57 0 1280x1024-PNG/index.html 133 20 121 297 297,173,122,121,124,125
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	58 1 bugzilla.mozilla.org/index.html 233 37 192 395 395,273,223,192,198,279
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	59 2 espn.go.com/index.html 118 1 116 254 254,117,116,119,119,117
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	60 3 home.netscape.com/index.html 98 47 3 124 3,121,120,124,124,121
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	61 ============================================================
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	62
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	63 Sample 'tinderbox' format output:
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	64
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	65 __start_tp_report
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	66 _x_x_mozilla_page_load,778.5,NaN,NaN
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	67 _x_x_mozilla_page_load_details,avgmedian\|778.5\|average\|766.75\|minimum\|NaN\|maximum\|NaN\|stddev\|NaN\|0;file:///c:/proj/mozilla-cvs/perf/tp2/base/www.cnn.com/index.html;778.5;766.75;722;1027;1027;788;777;722;780\|...
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	68 __end_tp_report
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	69
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	70 Note that the minimum, maximum, stddev are not calculated; they're
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	71 always reported as NaN. (They were the minimum and maximum values of
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	72 any sampled value, and the standard deviation across all sampled
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	73 values -- not very useful.)
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	74
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	75 TODO
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	76 ====
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	77
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	78 * Command line option to choose whether to run with or without browser chrome. Currently runs without.
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	79
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	80 * Tinderbox-dropping style output
dd0018bc27de Copy the pageloader from CVS and into a bundle format (single chrome.manifest). Benjamin Smedberg <benjamin@smedbergs.us> parents: diff changeset	81 * better yet would be to teach tinderbox about JSON

Mercurial > hg > config

annotate README @ 198:59d4f04497dd