tools/performance/layout/readme.txt

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/tools/performance/layout/readme.txt	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,32 @@
     1.4 +readme.txt - if there is a perf.html file, read that, it contains the full documentation. This file is a stop-gap until the documentation is completed.
     1.5 +
     1.6 +The cached websites must be downloaded and installed under the
     1.7 +performance\layout directory. You can find them at
     1.8 +http://techno/users/attinasi/publish and click on the WebSites in ZIP format.
     1.9 +Unzip the archive and make sure the websites extracted correctly.
    1.10 +
    1.11 +BASICS: to run the performance tool simply execute the perf.pl script.
    1.12 + eg. perl perf.pl Daily-021400 s:\mozilla\dist\win32_o.obj CPU
    1.13 +
    1.14 +This command will run viewer, crawl the top 40 URLs, dump the results to a file and subsequently parse the file to create the HTML performance table.
    1.15 +
    1.16 +To run Mozilla instead of viewer, edit the perf.pl script and change the $UseViewer variable value to 0. Then, run the perf.pl script, except there is an additional argument:
    1.17 + perl perf.pl Daily-021400 s:\mozilla\dist\win32_o.obj CPU profilename
    1.18 +
    1.19 +Including the profilename is essential, and the profilename specified must reference a valid profile.
    1.20 +
    1.21 +The output from the scripts is:
    1.22 +
    1.23 +1) BUILD_NAME.html in the Tables directory - the performance table
    1.24 +2) BUILD_NAME-TrendTable.html in the Tables directory - the trending table
    1.25 +3) BUILD_NAME directory under Logs - includes all of the original log files
    1.26 +4) history.txt - appends the latest averages to the history file
    1.27 +
    1.28 +If a run is aborted or is not to be used, the history.txt file must be edited to remove the bogus run.
    1.29 +
    1.30 +If problems arise in the scripts, there are debug routeins in each script file. Simply remove the comment from the print line and re-run to get diagnostics dumped to the console.
    1.31 +
    1.32 +
    1.33 +
    1.34 +... more to come...
    1.35 +

mercurial