fune/testing/perfdocs/generated/tools.rst
Alex Ionescu e5da1f325e Bug 1789229 - Add side-by-side docs r=perftest-reviewers,sparky
Add docs and fix a local bug that prevents the command from running.

Differential Revision: https://phabricator.services.mozilla.com/D157920
2022-09-23 14:33:21 +00:00

21 lines
580 B
ReStructuredText

Running a performance tool
==========================
You can run `perftest-tools` locally.
Running locally
---------------
You can run `mach perftest-tools` in a mozilla-central source
checkout::
$ ./mach perftest-tools side-by-side --help
The `mach` command will bootstrap the installation of all required dependencies for the
side-by-side tool to run.
The following arguments are required: `-t/--test-name`, `--base-revision`, `--new-revision`,
`--base-platform`
The `--help` argument will explain more about what arguments you need to
run in order to use the tool.