Name Date Size #Lines LOC

..--

generated/H25-Apr-2025-252242

recipe_modules/H25-Apr-2025-653488

recipes/H25-Apr-2025-11,39611,328

PRESUBMIT.pyH A D25-Apr-20251.4 KiB4219

README.recipes.mdH A D25-Apr-20257.5 KiB12277

main.starH A D25-Apr-20253.5 KiB11178

recipes.pyH A D25-Apr-20259 KiB276177

README.recipes.md

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