From 8cf7fdb567b0559e980daa6ce16f0e1fce95e833 Mon Sep 17 00:00:00 2001 From: Mark Robert Miller Date: Thu, 27 Aug 2009 00:09:13 +0000 Subject: [PATCH] move package.html to correct spot git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@808231 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/lucene/benchmark/package.html | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 contrib/benchmark/src/java/org/apache/lucene/benchmark/package.html diff --git a/contrib/benchmark/src/java/org/apache/lucene/benchmark/package.html b/contrib/benchmark/src/java/org/apache/lucene/benchmark/package.html new file mode 100644 index 00000000000..e671b371b2d --- /dev/null +++ b/contrib/benchmark/src/java/org/apache/lucene/benchmark/package.html @@ -0,0 +1,44 @@ + + + + Lucene Benchmarking Package + + +
+

+ The benchmark contribution contains tools for benchmarking Lucene using a standard, freely available corpus. ANT will + download the corpus automatically, place it in a temp directory and then unpack it to the working.dir directory specified in the build. + The temp directory + and working directory can be safely removed after a run. However, the next time the task is run, it will need to download the files again. +

+ Classes implementing the Benchmarker interface should have a no-argument constructor if they are to be used with the Driver class. The Driver + class is provided for convenience only. Feel free to implement your own main class for your benchmarker. +

+ The StandardBenchmarker is meant to be just that, a standard that runs out of the box with no configuration or changes needed. + Other benchmarking classes may derive from it to provide alternate views or to take in command line options. When reporting benchmarking runs + you should state any alterations you have made. +

+ To run the short version of the StandardBenchmarker, call "ant run-micro-standard". This should take a minute or so to complete and give you a preliminary idea of how your change affects the code +

+ To run the long version of the StandardBenchmarker, call "ant run-standard". This takes considerably longer. +

+ The original code for these classes was donated by Andrzej Bialecki at http://issues.apache.org/jira/browse/LUCENE-675 and has been updated by Grant Ingersoll to make some parts of the code reusable in other benchmarkers +

+
 
+ + \ No newline at end of file