1614443 - ./mach browsertime --help should document passing args to browsertime

Status: RESOLVED FIXED

(Testing :: Performance, enhancement, P3)

Description

[Beth Rennie [:beth] (she/her)]

./mach browsertime supports passing arugments to the browsertime script via, e.g., ./mach browsertime -- --firefox.binaryPath /usr/bin/firefox, but this is not documented and therefore unrecoverable. The --help docs should be updated to indicate this is possible, maybe with a list of pertinent/common browsertime flags.

Comment 1

[Myeongjun Go]

Hello.
I have some questions about this issue.
I checked browsertime arguments more than 20 (e.g - --firefox.binaryPath, --firefox.geckodriverPath, --firefox.nightly and so on).
It have many arguments (command) than I think. It want add all argument?
Also, I wonder if this is the right approach.
I'll attach a command example as an attachment.

Comment 2

[Myeongjun Go]

Attachment: browsertime_args_list.png

Comment 3

[Greg Mierzwinski [:sparky]]

Hi Myeongjun! Thanks for your interest in this issue.

Rather than add the options one at a time, you'll have to have our ./mach browsertime tool output the command line options from browsertime itself. You'll have to add something here to do the output: https://dxr.mozilla.org/mozilla-central/source/tools/browsertime/mach_commands.py#551

You'll need to add a --browsertime-help flag, and then output the browsertime help message when it's given. We won't be able to use the --help command because we need to have browsertime setup to be able to find all the command-line options (if we use --help, we'll break the standard help message that will tell people how to setup).

Comment 4

[Myeongjun Go]

Attachment: Bug 1614443 - added browsertime usage command(--browsertime-help) r=sparky

Comment 5

[Myeongjun Go]

Thanks Greg :)
I submitted patch.
Please let me know if there is anything that needs to be modified.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/9911fb331155
added browsertime usage command(--browsertime-help) r=sparky,perftest-reviewers

Comment 7

[Noemi Erli[:noemi_erli]]

https://hg.mozilla.org/mozilla-central/rev/9911fb331155