1393590 - [mach] Replace settings' gettext locale mechanism with a description attribute

Status: RESOLVED FIXED

(Firefox Build System :: Mach Core, enhancement)

Description

[Andrew Halberstadt [:ahal]]

I've been wanting to add a bunch of settings to mach, but keep putting it off because it's such a pain to generate the locale strings. Let's just use a description field instead.

Comment 1

[Andrew Halberstadt [:ahal]]

Attachment: Bug 1393590 - [mach] Use description field for settings instead of gettext locales,

This preserves ./mach settings' --list option. If --list is passed in, we call splitlines()
on the description and print only the first line. The full multi-line description will be
printed otherwise.

This also displays the type and/or choices of the option as appropriate.

Review commit: https://reviewboard.mozilla.org/r/172688/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/172688/

Comment 2

[Gregory Szorc [:gps]]

Comment on attachment 8901229 [details]
Bug 1393590 - [mach] Use description field for settings instead of gettext locales,

https://reviewboard.mozilla.org/r/172688/#review178246

Thank you for doing this.

As I was reading this, I wondered if it would be useful to declare options using functions. That way, you could use the docstring as the description string. But that's obviously follow-up fodder.

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/40d1b97a874d
[mach] Use description field for settings instead of gettext locales, r=gps

Comment 4

[Phil Ringnalda (:philor)]

https://hg.mozilla.org/mozilla-central/rev/40d1b97a874d