ICU-531.30.tar.gz

[apple/icu.git] / icuSources / test / perf / README

diff --git a/icuSources/test/perf/README b/icuSources/test/perf/README
index 03acaaed8c7f27109a1ac6ccea77ab2e3f88d6e9..276a84bd723909582a20425d2286bf291e9377c3 100644 (file)
--- a/icuSources/test/perf/README
+++ b/icuSources/test/perf/README
@@ -1,4 +1,4 @@
-Copyright (C) 2008, International Business Machines
+Copyright (C) 2008-2013, International Business Machines
 Corporation and others.  All Rights Reserved.
 
 README for ICU4C Performance Test
@@ -13,7 +13,7 @@ have its own web page.
 
 Requirements:
 The most up to date tests are in ICU 4.0 and later. In addition, most tests depend on data which are 
-in a seperate repository.  
+in a separate repository.
 
 Data repository:
 http://source.icu-project.org/repos/icu/data/trunk/test/perf
@@ -22,18 +22,15 @@ There are 3 folders in here: collation, conversion, and udr.
 
 Running Performance Test:
 
-1) You should create a directory to hold the ICU (current and previous versions) and the data.
-   (e.g. C:\ICUPerformanceTest)
+1) Checkout the current ICU and 2 previous versions (for proper regression testing) and the data
+   into your local system.
 
-2) Checkout the current ICU and 2 previous versions (for proper regression testing) and the data
-   into the ICUPerformanceTest directory.
+2) Do a general build on all the ICUs either through Visual Studios or with the Makefile.
 
-3) Do a general build on all the ICUs either through Visual Studios or with the Makefile.
-
-4) Build the ICU performance tests either through Visual Studios or with the Makefile.
+3) Build the ICU performance tests either through Visual Studios or with the Makefile.
    (The location of the performance test is: icu/source/test/perf)
 
-5) Go to perf/perldriver and edit Common.pl.
+4) Go to perf/perldriver, copy Common.pl.template to Common.pl.
    In this file, you will need to set a few variables:
    a) ICU version numbers
    b) Path to the performance test data
@@ -42,12 +39,14 @@ Running Performance Test:
    * The Path needs to be absolute
    * All other variables should be left as is
 
+5) Create a directory pref/results. All of the test result web pages will be
+   stored in this directory.
+
 6) In the perf directory, there are several other directories for the various tests that can be run.
    (e.g. convperf (Conversion tests)). Go to each directory and execute the perl script for each test
    you want to run. (e.g. CharPerf_r.pl in CharPerf directory)
    * You only need to run the perl script from the latest ICU version.  The corresponding perl script 
      in the previous versions of ICU do not need to be run seperately.
-   * All of the test result web pages will be stored in perf/results.
 
 
 Note: When running on Windows, cygwin is preferred.
@@ -59,3 +58,5 @@ Note: To run the actual performance test, you will need to setup Perl with the f
       b) Statistics/Descriptive.pm 
 Note: Some tests take a while depending on the machine it is running on so a script to run each performance test's
       perl script might be helpful.
+Note: The perl script is only used in one version of ICU. When you run regression tests,
+      it is recommended to run the tests from the later version of ICU.