summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--NEWS2
-rw-r--r--README_DEVELOPERS24
2 files changed, 25 insertions, 1 deletions
diff --git a/NEWS b/NEWS
index 4c57553e..b87a9a45 100644
--- a/NEWS
+++ b/NEWS
@@ -83,7 +83,7 @@ Lackey has been improved, and MPI support has been added. In detail:
have been fixed.
- A simple performance evaluation suite has been added. See
- perf/README for details. "make perf" runs the tests. There are
+ perf/README and README_DEVELOPERS for details. There are
various bells and whistles.
- New configuration flags:
diff --git a/README_DEVELOPERS b/README_DEVELOPERS
index 2797565c..78350283 100644
--- a/README_DEVELOPERS
+++ b/README_DEVELOPERS
@@ -33,6 +33,30 @@ file. Eg:
perl tests/vg_regtest memcheck/tests/badfree
+Running the performance suite
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+To build and run the whole performance suite, run "make [--quiet] perf".
+
+To run a subset of the regression tests, execute:
+
+ perl perf/vg_perf <name>
+
+where <name> is a directory (all tests within will be run) or a single
+.vgperf test file, or the name of a program which has a like-named .vgperf
+file. Eg:
+
+ perl perf/vg_perf perf/
+ perl perf/vg_perf perf/bz2.vgperf
+ perl perf/vg_perf perf/bz2
+
+To compare multiple versions of Valgrind, use the --vg= options multiple
+times. For example, if you have two Valgrinds next to each other, one in
+trunk1/ and one in trunk2/, from either trunk1/ or trunk2/ do this to
+compare them on the entire suite:
+
+ perl perf/vg_perf --vg=../trunk1 --vg=../trunk2 perf/
+
+
Debugging Valgrind with GDB
~~~~~~~~~~~~~~~~~~~~~~~~~~~
To debug the valgrind launcher program (<prefix>/bin/valgrind) just