1108399 - mach sub commands

Status: RESOLVED FIXED

(Firefox Build System :: Mach Core, enhancement)

Description

[Gregory Szorc [:gps]]

A few times I've wanted to write sub commands in mach. e.g. |mach command foo| and |mach command bar|. The work I'm doing in bug 1108293 is the latest such driver.

Let's implement sub commands in mach.

Comment 1

[Gregory Szorc [:gps]]

Attachment: MozReview Request: bz://1108399/gps

Comment 2

[Gregory Szorc [:gps]]

/r/1233 - Bug 1108399 - Move mach docs into sphinx
/r/1235 - Bug 1108399 - Improve code linking in mach docs
/r/1237 - Bug 1108399 - Split mach documentation into multiple articles
/r/1239 - Bug 1108399 - Properly link to Python docs
/r/1241 - Bug 1108399 - Fix docs for mach decorators
/r/1243 - Bug 1108399 - Remove outdated comment about hooking up conditional commands
/r/1245 - Bug 1108399 - Properly name command help function
/r/1247 - Bug 1108399 - Introduce decorator for mach sub-commands
/r/1249 - Bug 1108399 - Split command group populating into own function
/r/1251 - Bug 1108399 - Handle help on mach sub-commands
/r/1253 - Bug 1108399 - Implement mach sub-command dispatching

Pull down these commits:

hg pull review -r fcebbe1c01c96327c5fe7c2866bf8a231e51f24e

Comment 3

[Ali Al Dallal [:alicoding]]

FYI: You've flagged wrong Ali to review I believe :)

Comment 4

[Gregory Szorc [:gps]]

/r/1233 - Bug 1108399 - Move mach docs into sphinx
/r/1235 - Bug 1108399 - Improve code linking in mach docs
/r/1237 - Bug 1108399 - Split mach documentation into multiple articles
/r/1239 - Bug 1108399 - Properly link to Python docs
/r/1241 - Bug 1108399 - Fix docs for mach decorators
/r/1243 - Bug 1108399 - Remove outdated comment about hooking up conditional commands
/r/1245 - Bug 1108399 - Properly name command help function
/r/1247 - Bug 1108399 - Introduce decorator for mach sub-commands
/r/1249 - Bug 1108399 - Split command group populating into own function
/r/1251 - Bug 1108399 - Handle help on mach sub-commands
/r/1253 - Bug 1108399 - Implement mach sub-command dispatching

Pull down these commits:

hg pull review -r fcebbe1c01c96327c5fe7c2866bf8a231e51f24e

Comment 5

[Gregory Szorc [:gps]]

Ali: Oops, sorry about that.

Comment 6

[Andrew Halberstadt [:ahal]]

https://reviewboard.mozilla.org/r/1231/#review725

::: python/mach/mach/decorators.py
(Diff revision 1)
> +    # reconcile state after traversal.

Typo: paren't. Also either 'hold' or 'reconcile' should be removed.

::: python/mach/mach/decorators.py
(Diff revision 1)
> +    def __init__(self, command, subcommand, description=None):

Shouldn't this also accept the parser argument?

::: python/mach/mach/dispatcher.py
(Diff revision 1)
> +            if not args:

Does this mean if |mach command subcommand| exists it's not possible to run |mach command| on its own? Seems like that could sometimes be desirable.

Comment 7

[Andrew Halberstadt [:ahal]]

Comment on attachment 8532947 [details]
MozReview Request: bz://1108399/gps

It's not really clear if I should be flipping the bz flag after a mozreview. I'd give an r+ with my questions answered.

Comment 8

[Gregory Szorc [:gps]]

https://reviewboard.mozilla.org/r/1231/#review941

> Shouldn't this also accept the parser argument?

No. @CommandArgument works for both @Command and @SubCommand.

> Does this mean if |mach command subcommand| exists it's not possible to run |mach command| on its own? Seems like that could sometimes be desirable.

For now, yes. I would be in favor of adding this feature later, if it is ever needed.

Comment 9

[Andrew Halberstadt [:ahal]]

https://reviewboard.mozilla.org/r/1231/#review945

Feel free to ignore the parser argument if it doesn't make sense to do that, I don't want to hold this up over that.

Comment 10

[Gregory Szorc [:gps]]

/r/1233 - Bug 1108399 - Move mach docs into sphinx
/r/1235 - Bug 1108399 - Improve code linking in mach docs
/r/1237 - Bug 1108399 - Split mach documentation into multiple articles
/r/1239 - Bug 1108399 - Properly link to Python docs
/r/1241 - Bug 1108399 - Fix docs for mach decorators
/r/1243 - Bug 1108399 - Remove outdated comment about hooking up conditional commands
/r/1245 - Bug 1108399 - Properly name command help function
/r/1247 - Bug 1108399 - Introduce decorator for mach sub-commands
/r/1249 - Bug 1108399 - Split command group populating into own function
/r/1251 - Bug 1108399 - Handle help on mach sub-commands
/r/1253 - Bug 1108399 - Implement mach sub-command dispatching

Pull down these commits:

hg pull review -r f81c4c55db4b262e6c3f52d638f66b75d2d5d4e2

Comment 11

[Gregory Szorc [:gps]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/9e172488cad4
https://hg.mozilla.org/integration/mozilla-inbound/rev/9b961333f771
https://hg.mozilla.org/integration/mozilla-inbound/rev/d6a8be98af5c
https://hg.mozilla.org/integration/mozilla-inbound/rev/1eb16bd19578
https://hg.mozilla.org/integration/mozilla-inbound/rev/569de20471b0
https://hg.mozilla.org/integration/mozilla-inbound/rev/63fbfec875b8
https://hg.mozilla.org/integration/mozilla-inbound/rev/1d6dac555b51
https://hg.mozilla.org/integration/mozilla-inbound/rev/75933db445f8
https://hg.mozilla.org/integration/mozilla-inbound/rev/a624875e4720
https://hg.mozilla.org/integration/mozilla-inbound/rev/89a1070e2263
https://hg.mozilla.org/integration/mozilla-inbound/rev/f6a7a1184a77

Comment 12

[Gregory Szorc [:gps]]

Comment on attachment 8532947 [details]
MozReview Request: bz://1108399/gps

Not sure why r+ from MozReview didn't come through :/

Comment 13

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/9e172488cad4
https://hg.mozilla.org/mozilla-central/rev/9b961333f771
https://hg.mozilla.org/mozilla-central/rev/d6a8be98af5c
https://hg.mozilla.org/mozilla-central/rev/1eb16bd19578
https://hg.mozilla.org/mozilla-central/rev/569de20471b0
https://hg.mozilla.org/mozilla-central/rev/63fbfec875b8
https://hg.mozilla.org/mozilla-central/rev/1d6dac555b51
https://hg.mozilla.org/mozilla-central/rev/75933db445f8
https://hg.mozilla.org/mozilla-central/rev/a624875e4720
https://hg.mozilla.org/mozilla-central/rev/89a1070e2263
https://hg.mozilla.org/mozilla-central/rev/f6a7a1184a77

Comment 15

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Split command group populating into own function

Comment 16

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Handle help on mach sub-commands

Comment 17

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Implement mach sub-command dispatching

Comment 18

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Move mach docs into sphinx

Comment 19

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Improve code linking in mach docs

Comment 20

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Split mach documentation into multiple articles

Comment 21

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Properly link to Python docs

Comment 22

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Fix docs for mach decorators

Comment 23

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Remove outdated comment about hooking up conditional commands

Comment 24

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Properly name command help function

Comment 25

[Gregory Szorc [:gps]]

Attachment: MozReview Request: Bug 1108399 - Introduce decorator for mach sub-commands