bench/README.txt

   1 # __COPYRIGHT__
   2
   3 This subdirectory contains a harness and various timing tests that we've
   4 used to decide on the most efficient implementation of various pieces
   5 of the code base.  We're checking these in here so that they're always
   6 available in case we have to revisit these decisions.
   7
   8 NOTE:  This harness is for horse-racing specific snippets of Python
   9 code to select the best implementation to use within a given function
  10 or subsystem.  It's not intended for end-to-end testing of SCons itself.
  11
  12 Contents of the directory:
  13
  14     README.txt
  15
  16         What you're reading right now.
  17
  18     bench.py
  19
  20         The harness for running the timing tests that make up
  21         the rest of the directory's contents.  Use it to run
  22         one of the timing tests as follows:
  23
  24                 python bench.py FILE
  25
  26         Various command-line options control the number of runs, the
  27         number of iterations on each run, etc.  Help for the command-line
  28         options is available:
  29
  30                 python bench.py -h
  31
  32     is_types.py
  33     lvars-gvars.py
  34     [etc.]
  35
  36         The rest of the files in this directory should each contain a
  37         specific timing test, consisting of various functions to be run
  38         against each other, and test data to be passed to the functions.
  39
  40         Yes, this list of files will get out of date.