mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-11-12 14:20:14 +02:00
d8a05f2775
This adds some basic documentation for |mach try| and its various subcommands. This was a bit hastily made for the Austin all-hands, but at least provides a place to link to and can be improved upon in the future. MozReview-Commit-ID: 8N6LZO5kTlL --HG-- extra : rebase_source : c7e215703426f6cfb03b044d188a53d1ba878a75
50 lines
2 KiB
ReStructuredText
50 lines
2 KiB
ReStructuredText
Syntax Selector
|
|
===============
|
|
|
|
.. warning::
|
|
|
|
Try syntax is antiquated and hard to understand. If you aren't already
|
|
familiar with try syntax, you might want to use the ``fuzzy`` selector
|
|
instead.
|
|
|
|
Try syntax is a command line string that goes into the commit message. Using
|
|
``mach try syntax`` will automatically create a temporary commit with your
|
|
chosen syntax and then delete it again after pushing to try.
|
|
|
|
Try syntax can contain all kinds of different options parsed by various
|
|
places in various repos, but the majority are parsed by `try_option_syntax.py`_.
|
|
The most common arguments include:
|
|
|
|
* ``-b/--build`` - One of ``d``, ``o`` or ``do``. This is the build type,
|
|
either opt, debug or both (required).
|
|
* ``-p/--platform`` - The platforms you want to build and/or run tests on
|
|
(required).
|
|
* ``-u/--unittests`` - The test tasks you want to run (optional).
|
|
* ``-t/--talos`` - The talos tasks you want to run (optional).
|
|
|
|
Here are some examples:
|
|
|
|
.. code-block:: shell
|
|
|
|
$ mach try syntax -b do -p linux,macosx64 -u mochitest-e10s-1,crashtest -t none
|
|
$ mach try syntax -b d -p win64 -u all
|
|
$ mach try syntax -b o -p linux64
|
|
|
|
Unfortunately, knowing the magic strings that make it work can be a bit of a
|
|
guessing game. If you are unsure of what string will get your task to run, try
|
|
using :doc:`mach try fuzzy <fuzzy>` instead.
|
|
|
|
While using ``mach try syntax -b do -p all -u all -t all`` will work, heavy use
|
|
of ``all`` is discouraged as it consumes a lot of unnecessary resources (some of
|
|
which are hardware constrained).
|
|
|
|
Trychooser
|
|
~~~~~~~~~~
|
|
|
|
Commonly the `trychooser`_ web page is used to help build a try syntax, though
|
|
it isn't always kept up to date. Check the boxes for the tasks you wish to run
|
|
then copy/paste the computed ``mach try`` command into your terminal.
|
|
|
|
|
|
.. _try_option_syntax.py: https://hg.mozilla.org/mozilla-central/file/tip/taskcluster/taskgraph/try_option_syntax.py
|
|
.. _trychooser: https://mozilla-releng.net/trychooser/
|