Source code
Revision control
Copy as Markdown
Other Tools
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this file,
from mach.decorators import SettingsProvider
@SettingsProvider
class MachSettings:
@classmethod
def config_settings(cls):
def telemetry_config_settings():
return [
(
"build.telemetry",
"boolean",
"Enable submission of build system telemetry "
'(Deprecated, replaced by "telemetry.is_enabled")',
),
(
"mach_telemetry.is_enabled",
"boolean",
"Build system telemetry is allowed",
False,
),
(
"mach_telemetry.is_set_up",
"boolean",
"The telemetry setup workflow has been completed "
"(e.g.: user has been prompted to opt-in)",
False,
),
]
def dispatch_config_settings():
return [
(
"alias.*",
"string",
"""
Create a command alias of the form `<alias>=<command> <args>`.
Aliases can also be used to set default arguments:
<command>=<command> <args>
""".strip(),
),
]
def run_config_settings():
return [
(
"runprefs.*",
"string",
"""
Pass a pref into Firefox when using `mach run`, of the form `foo.bar=value`.
Prefs will automatically be cast into the appropriate type. Integers can be
single quoted to force them to be strings.
""".strip(),
),
]
def try_config_settings():
desc = "The default selector to use when running `mach try` without a subcommand."
choices = [
"fuzzy",
"chooser",
"auto",
"again",
"empty",
"syntax",
"coverage",
"release",
"scriptworker",
"compare",
"perf",
]
return [
("try.default", "string", desc, "auto", {"choices": choices}),
(
"try.maxhistory",
"int",
"Maximum number of pushes to save in history.",
10,
),
]
def taskgraph_config_settings():
return [
(
"taskgraph.diffcmd",
"string",
"The command to run with `./mach taskgraph --diff`",
"diff --report-identical-files "
"--label={attr}@{base} --label={attr}@{cur} -U20",
{},
)
]
def test_config_settings():
from mozlog.commandline import log_formatters
from mozlog.structuredlog import log_levels
format_desc = (
"The default format to use when running tests with `mach test`."
)
format_choices = list(log_formatters)
level_desc = (
"The default log level to use when running tests with `mach test`."
)
level_choices = [l.lower() for l in log_levels]
return [
(
"test.format",
"string",
format_desc,
"mach",
{"choices": format_choices},
),
(
"test.level",
"string",
level_desc,
"info",
{"choices": level_choices},
),
]
settings = []
settings.extend(telemetry_config_settings())
settings.extend(dispatch_config_settings())
settings.extend(run_config_settings())
settings.extend(try_config_settings())
settings.extend(taskgraph_config_settings())
settings.extend(test_config_settings())
return settings