diff options
author | 2017-03-03 10:21:15 +0000 | |
---|---|---|
committer | 2017-03-03 10:40:15 +0000 | |
commit | 2697dd3e7f3b66918a2a3aa5a74144cf0c5a61f0 (patch) | |
tree | ea7d1ced5d3de027c85c9a29623e87660af41579 /src/tools/benchmark | |
parent | b2f1e19ae8b82bc6c2ddc7f5b5ccec1544fd7901 (diff) |
Some little tweaks to benchmark/README.md.
--
PiperOrigin-RevId: 149094351
MOS_MIGRATED_REVID=149094351
Diffstat (limited to 'src/tools/benchmark')
-rw-r--r-- | src/tools/benchmark/README.md | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/src/tools/benchmark/README.md b/src/tools/benchmark/README.md index 0646dfc46e..b370915a7c 100644 --- a/src/tools/benchmark/README.md +++ b/src/tools/benchmark/README.md @@ -1,11 +1,20 @@ -# Benchmark +# Build Performance Benchmark -This benchmark is for comparing performance (elapsed time) between several bazel commits. -It requires bazel and git installed. +This benchmark is used to measure and compare Bazel's performance (elapsed time +of builds) between several commits. It requires bazel and git to be installed. + +To run the benchmark: -To Run the benchmark: 1. `bazel build //src/tools/benchmark/java/com/google/devtools/build/benchmark:benchmark` -2. run the built binary and follow the argument instruction -3. put the benchmark result as `<name>.json` into `src/tools/benchmark/webapp/data` -4. put the string `<name>.json` into `src/tools/benchmark/webapp/file_list` -5. start an http server there and open `/index.html` +2. Run the built binary and follow the instructions. +3. Put the benchmark result file as `<name>.json` into the directory + `src/tools/benchmark/webapp/data`. +4. Put the string `<name>.json` into the file + `src/tools/benchmark/webapp/file_list`. +5. Start an HTTP server there and open `/index.html`. + - Hint: You can start a simple HTTP server by running + `python -m SimpleHTTPServer` (Python 2) or + `python3 -m http.server` (Python 3). + +A hosted version of the benchmark that is kept up to date by our CI system is +available here: https://perf.bazel.build/. |