Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1121)

Side by Side Diff: scripts/slave/README.recipes.md

Issue 1111413005: Some changes to allow recipes and modules to live noncentrally (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/tools/build
Patch Set: Little bitty cleanup Created 5 years, 7 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | scripts/slave/annotated_run.py » ('j') | scripts/slave/annotated_run.py » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 Recipes 1 Recipes
2 ======= 2 =======
3 Recipes are a flexible way to specify How to Do Things, without knowing too much 3 Recipes are a flexible way to specify How to Do Things, without knowing too much
4 about those Things. 4 about those Things.
5 5
6 6
7 Background 7 Background
8 ---------- 8 ----------
9 9
10 Chromium uses BuildBot for its builds. It requires master restarts to change 10 Chromium uses BuildBot for its builds. It requires master restarts to change
(...skipping 332 matching lines...) Expand 10 before | Expand all | Expand 10 after
343 ```python 343 ```python
344 for TARGET in ('Bob', 'DarthVader', 'Charlie'): 344 for TARGET in ('Bob', 'DarthVader', 'Charlie'):
345 for test_function in (super_tool, default_tool): 345 for test_function in (super_tool, default_tool):
346 yield TestCase(test_function(BasicSchema(TARGET))) 346 yield TestCase(test_function(BasicSchema(TARGET)))
347 ``` 347 ```
348 348
349 Next, we get to the `config_ctx`. This is the 'context' for all the config 349 Next, we get to the `config_ctx`. This is the 'context' for all the config
350 items in this file, and will become the `CONFIG_CTX` for the entire module. 350 items in this file, and will become the `CONFIG_CTX` for the entire module.
351 Other modules may add into this config context (for example, they could have 351 Other modules may add into this config context (for example, they could have
352 a `hello_config.py` file, which imports this config context like 352 a `hello_config.py` file, which imports this config context like
353 `from RECIPE_MODULES.hello import CONFIG_CTX`. This will be useful for 353 `CONFIG_CTX = DEPS['hello'].CONFIG_CTX`. This will be useful for
iannucci 2015/05/05 23:35:58 import DEPS CONFIG_CTX = DEPS['hello'].CONFIG_CTX
luqui 2015/05/06 22:18:39 Done.
354 separation of concerns with the `set_config()` method.). The string format 354 separation of concerns with the `set_config()` method.). The string format
355 argument that `config_item_context` takes will be used to format the test case 355 argument that `config_item_context` takes will be used to format the test case
356 names and test expectation file names. Not terribly useful here, but it can be 356 names and test expectation file names. Not terribly useful here, but it can be
357 useful for making the test names more obvious in more complex cases. 357 useful for making the test names more obvious in more complex cases.
358 358
359 Finally we get to the config items themselves. A config item is a function 359 Finally we get to the config items themselves. A config item is a function
360 decorated with the `config_ctx`, and takes a config blob as 'c'. The config item 360 decorated with the `config_ctx`, and takes a config blob as 'c'. The config item
361 updates the config blob, perhaps conditionally. There are many features to 361 updates the config blob, perhaps conditionally. There are many features to
362 `slave/recipe_config.py`. I would recommend reading the docstrings there 362 `slave/recipe_config.py`. I would recommend reading the docstrings there
363 for all the details. 363 for all the details.
(...skipping 169 matching lines...) Expand 10 before | Expand all | Expand 10 after
533 Where's the docs on `*.py`? 533 Where's the docs on `*.py`?
534 -------------------------------------------- 534 --------------------------------------------
535 Check the docstrings in `*.py`. `<trollface text="Problem?"/>` 535 Check the docstrings in `*.py`. `<trollface text="Problem?"/>`
536 536
537 In addition, most recipe modules have an `example.py` file which exercises most 537 In addition, most recipe modules have an `example.py` file which exercises most
538 of the code in the module for both test coverage and example purposes. 538 of the code in the module for both test coverage and example purposes.
539 539
540 If you want to know what keys a step dictionary can take, take a look at 540 If you want to know what keys a step dictionary can take, take a look at
541 `common/annotator.py`. 541 `common/annotator.py`.
542 542
OLDNEW
« no previous file with comments | « no previous file | scripts/slave/annotated_run.py » ('j') | scripts/slave/annotated_run.py » ('J')

Powered by Google App Engine
This is Rietveld 408576698