[cairo-perf-diff] Update usage screen to mention --html.

This commit is contained in:
Mathias Hasselmann 2007-03-15 12:47:41 +01:00
parent 6ff2439b33
commit 562bd551bc

View file

@ -3,37 +3,48 @@ set -e
usage() {
argv0=$(basename $0)
echo "Usage:" >&2
echo "For comparing files created my cairo-perf:" >&2
echo "" >&2
echo " $argv0 old.perf new.perf" >&2
echo "" >&2
echo "For comparing (cached) performance of revisions:" >&2
echo "" >&2
echo " $argv0 [-f] <revision> [-- cairo-perf options]" >&2
echo " $argv0 [-f] <rev1> <rev2> [-- cairo-perf-options]" >&2
echo "" >&2
echo "If given a single revision, compares its results to that of its" >&2
echo "(first-parent) predecessor. Otherwise compares the two given revisions." >&2
echo "The revisions can be any revision accepted by git. For example:" >&2
echo "" >&2
echo " $argv0 HEAD # Show impact of latest commit" >&2
echo " $argv0 1.2.0 1.2.4 # Compare performance of 1.2.0 to 1.2.4" >&2
echo "" >&2
echo "The -f option forces cairo-perf-diff to re-run performance tests even" >&2
echo "if cached performance data is available." >&2
echo "" >&2
echo "Additional options can be passed the child cairo-perf process" >&2
echo "by separating them with a double hyphen (--). For example, to" >&2
echo "examine what the impact of the latest change is on the stroke" >&2
echo "test you might use:" >&2
echo "" >&2
echo " $argv0 HEAD -- stroke" >&2
echo "" >&2
echo "The performance results are cached in .perf next to the .git directory." >&2
echo "" >&2
echo "Set CAIRO_AUTOGEN_OPTIONS to pass options to autogen for both" >&2
echo "builds." >&2
cat >&2 << END
Usage:
For comparing files created my cairo-perf:
$argv0 old.perf new.perf
For comparing (cached) performance of revisions:
$argv0 [OPTIONS] <revision> [-- cairo-perf options]
$argv0 [OPTIONS] <rev1> <rev2> [-- cairo-perf-options]
If given a single revision, compares its results to that of its
(first-parent) predecessor. Otherwise compares the two given revisions.
The revisions can be any revision accepted by git. For example:
$argv0 HEAD # Show impact of latest commit
$argv0 1.2.0 1.2.4 # Compare performance of 1.2.0 to 1.2.4
Options:
-f, --force
Forces cairo-perf-diff to re-run performance tests
even if cached performance data is available.
-h, --html
With this option performance changes are summarized
as HTML table.
Additional options can be passed the child cairo-perf process
by separating them with a double hyphen (--). For example, to
examine what the impact of the latest change is on the stroke
test you might use:
$argv0 HEAD -- stroke
The performance results are cached in .perf next to the .git directory.
Set CAIRO_AUTOGEN_OPTIONS to pass options to autogen for both
builds.
END
exit 1
}