1<!--- AUTOGENERATED BY `./recipes.py test train` --> 2# Repo documentation for [gn]() 3## Table of Contents 4 5**[Recipe Modules](#Recipe-Modules)** 6 * [macos_sdk](#recipe_modules-macos_sdk) — The `macos_sdk` module provides safe functions to access a semi-hermetic XCode installation. 7 * [windows_sdk](#recipe_modules-windows_sdk) 8 9**[Recipes](#Recipes)** 10 * [gn](#recipes-gn) — Recipe for building GN. 11 * [macos_sdk:examples/full](#recipes-macos_sdk_examples_full) 12 * [windows_sdk:examples/full](#recipes-windows_sdk_examples_full) 13## Recipe Modules 14 15### *recipe_modules* / [macos\_sdk](/infra/recipe_modules/macos_sdk) 16 17[DEPS](/infra/recipe_modules/macos_sdk/__init__.py#5): [recipe\_engine/cipd][recipe_engine/recipe_modules/cipd], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/json][recipe_engine/recipe_modules/json], [recipe\_engine/path][recipe_engine/recipe_modules/path], [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/step][recipe_engine/recipe_modules/step] 18 19The `macos_sdk` module provides safe functions to access a semi-hermetic 20XCode installation. 21 22Available only to Google-run bots. 23 24#### **class [MacOSSDKApi](/infra/recipe_modules/macos_sdk/api.py#14)([RecipeApi][recipe_engine/wkt/RecipeApi]):** 25 26API for using OS X SDK distributed via CIPD. 27 28  **@contextmanager**<br>— **def [\_\_call\_\_](/infra/recipe_modules/macos_sdk/api.py#24)(self):** 29 30Sets up the XCode SDK environment. 31 32This call is a no-op on non-Mac platforms. 33 34This will deploy the helper tool and the XCode.app bundle at 35`[START_DIR]/cache/macos_sdk`. 36 37To avoid machines rebuilding these on every run, set up a named cache in 38your cr-buildbucket.cfg file like: 39 40 caches: { 41 # Cache for mac_toolchain tool and XCode.app 42 name: "macos_sdk" 43 path: "macos_sdk" 44 } 45 46If you have builders which e.g. use a non-current SDK, you can give them 47a uniqely named cache: 48 49 caches: { 50 # Cache for N-1 version mac_toolchain tool and XCode.app 51 name: "macos_sdk_old" 52 path: "macos_sdk" 53 } 54 55Usage: 56 with api.macos_sdk(): 57 # sdk with mac build bits 58 59Raises: 60 StepFailure or InfraFailure. 61### *recipe_modules* / [windows\_sdk](/infra/recipe_modules/windows_sdk) 62 63[DEPS](/infra/recipe_modules/windows_sdk/__init__.py#5): [recipe\_engine/cipd][recipe_engine/recipe_modules/cipd], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/json][recipe_engine/recipe_modules/json], [recipe\_engine/path][recipe_engine/recipe_modules/path], [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/step][recipe_engine/recipe_modules/step] 64 65#### **class [WindowsSDKApi](/infra/recipe_modules/windows_sdk/api.py#10)([RecipeApi][recipe_engine/wkt/RecipeApi]):** 66 67API for using Windows SDK distributed via CIPD. 68 69  **@contextmanager**<br>— **def [\_\_call\_\_](/infra/recipe_modules/windows_sdk/api.py#19)(self):** 70 71Setups the Windows SDK environment. 72 73This call is a no-op on non-Windows platforms. 74 75Raises: 76 StepFailure or InfraFailure. 77## Recipes 78 79### *recipes* / [gn](/infra/recipes/gn.py) 80 81[DEPS](/infra/recipes/gn.py#8): [macos\_sdk](#recipe_modules-macos_sdk), [windows\_sdk](#recipe_modules-windows_sdk), [recipe\_engine/buildbucket][recipe_engine/recipe_modules/buildbucket], [recipe\_engine/cipd][recipe_engine/recipe_modules/cipd], [recipe\_engine/context][recipe_engine/recipe_modules/context], [recipe\_engine/file][recipe_engine/recipe_modules/file], [recipe\_engine/json][recipe_engine/recipe_modules/json], [recipe\_engine/path][recipe_engine/recipe_modules/path], [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/python][recipe_engine/recipe_modules/python], [recipe\_engine/raw\_io][recipe_engine/recipe_modules/raw_io], [recipe\_engine/step][recipe_engine/recipe_modules/step] 82 83Recipe for building GN. 84 85— **def [RunSteps](/infra/recipes/gn.py#29)(api, repository):** 86### *recipes* / [macos\_sdk:examples/full](/infra/recipe_modules/macos_sdk/examples/full.py) 87 88[DEPS](/infra/recipe_modules/macos_sdk/examples/full.py#5): [macos\_sdk](#recipe_modules-macos_sdk), [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/step][recipe_engine/recipe_modules/step] 89 90— **def [RunSteps](/infra/recipe_modules/macos_sdk/examples/full.py#13)(api):** 91### *recipes* / [windows\_sdk:examples/full](/infra/recipe_modules/windows_sdk/examples/full.py) 92 93[DEPS](/infra/recipe_modules/windows_sdk/examples/full.py#5): [windows\_sdk](#recipe_modules-windows_sdk), [recipe\_engine/platform][recipe_engine/recipe_modules/platform], [recipe\_engine/properties][recipe_engine/recipe_modules/properties], [recipe\_engine/step][recipe_engine/recipe_modules/step] 94 95— **def [RunSteps](/infra/recipe_modules/windows_sdk/examples/full.py#13)(api):** 96 97[recipe_engine/recipe_modules/buildbucket]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-buildbucket 98[recipe_engine/recipe_modules/cipd]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-cipd 99[recipe_engine/recipe_modules/context]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-context 100[recipe_engine/recipe_modules/file]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-file 101[recipe_engine/recipe_modules/json]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-json 102[recipe_engine/recipe_modules/path]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-path 103[recipe_engine/recipe_modules/platform]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-platform 104[recipe_engine/recipe_modules/properties]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-properties 105[recipe_engine/recipe_modules/python]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-python 106[recipe_engine/recipe_modules/raw_io]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-raw_io 107[recipe_engine/recipe_modules/step]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/README.recipes.md#recipe_modules-step 108[recipe_engine/wkt/RecipeApi]: https://chromium.googlesource.com/infra/luci/recipes-py.git/+/0589a429cf3c164004dae4ced4c75784a50afd81/recipe_engine/recipe_api.py#838 109