Index: tools/mb/docs/user_guide.md |
diff --git a/tools/mb/docs/user_guide.md b/tools/mb/docs/user_guide.md |
index af577a758b94f9686c6a19004d85f77b22be350b..9817553bf6a41dc9ba0c725f140b2c41e4e4b90f 100644 |
--- a/tools/mb/docs/user_guide.md |
+++ b/tools/mb/docs/user_guide.md |
@@ -112,7 +112,9 @@ a directory, then runs GYP or GN as appropriate: |
``` |
Either the `-c/--config` flag or the `-m/--master` and `-b/--builder` flags |
-must be specified so that `mb` can figure out which config to use. |
+must be specified so that `mb` can figure out which config to use. The |
+`--phase` flag must also be used with builders that have multiple |
+build/compile steps (and only with those builders). |
By default, MB will look for a bot config file under `//ios/build/bots` (see |
[design_spec.md](the design spec) for details of how the bot config files |
@@ -148,7 +150,8 @@ Prints what command will be run by `mb gen` (like `mb gen -n` but does |
not require you to specify a path). |
The `-b/--builder`, `-c/--config`, `-f/--config-file`, `-m/--master`, |
-`-q/--quiet`, and `-v/--verbose` flags work as documented for `mb gen`. |
+`--phase`, `-q/--quiet`, and `-v/--verbose` flags work as documented for |
+`mb gen`. |
### `mb validate` |
@@ -200,10 +203,14 @@ expression: a dictionary with three main keys, `masters`, `configs` and |
The `masters` key contains a nested series of dicts containing mappings |
of master -> builder -> config . This allows us to isolate the buildbot |
-recipes from the actual details of the configs. |
- |
-The `configs` key points to a dictionary of named build |
-configurations. |
+recipes from the actual details of the configs. The config should either |
+be a single string value representing a key in the `configs` dictionary, |
+or a list of strings, each of which is a key in the `configs` dictionary; |
+the latter case is for builders that do multiple compiles with different |
+arguments in a single build, and must *only* be used for such builders |
+(where a --phase argument must be supplied in each lookup or gen call). |
+ |
+The `configs` key points to a dictionary of named build configurations. |
There should be an key in this dict for every supported configuration |
of Chromium, meaning every configuration we have a bot for, and every |