-
Notifications
You must be signed in to change notification settings - Fork 15
/
whisk.example.yaml
289 lines (241 loc) · 10.2 KB
/
whisk.example.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
---
# This file describes how your project is configured. Any variables of the
# %NAME or %{NAME} will be expanded with the environment variable of the same
# name. In addition, the following variables will also be expanded:
#
# %WHISK_PROJECT_ROOT - The absolute path of the project root
#
# Whisk will fail if any undefined variables are encountered
#
# The version of this config file. Must be 1 or 2.
# Version changes:
# 2: No differences in the config file format. If this version is specified,
# whisk will not define DEPLOY_DIR_<PRODUCT> variable aliases, since they
# can cause problems if you product name happens to be an override
version: 2
# The location of the project root, relative to the parent directory of this
# configuration file. This value is evaluated before any variable expansion is
# done. Defaults to ".", meaning that this config file is in the root of the
# project
project_root: .
# The location where the user's locally configured cache will be stored
cache: "%{WHISK_PROJECT_ROOT}/.config.yaml"
defaults:
# The default values if the user has never configured before. If any are
# omitted, the user *must* specify them the first time they configure. Note
# that the default version is not configurable because it defaults to
# "default".
products: []
mode: release
site: roaming
# Default build directory, or "build" if unspecified
build_dir: build
# Shell code fragments that will be inserted into the shell code executed by
# the initialization script. All are optional. Whisk will set the following
# extra shell variables which may be used in these fragments:
#
# $WHISK_BUILD_DIR - The absolute path to the user specified build directory
# $WHISK_INIT - This variable will have the value "true" if this is the
# first time the environment is being initialized, and
# "false" if the user is re-configuring
hooks:
# Shell code executed before the version initialization script
pre_init: |
# placeholder
# Shell code executed after the version initialization script
post_init: |
# placeholder
# A list of environment variables to pass through to bitbake (e.g.
# BB_ENV_EXTRAWHITE/BB_ENV_PASSTHROUGH_ADDITIONS)
env_passthrough_vars: []
# Commands to run if the user specifies --fetch to fetch layers.
#
# Fetch commands are always run with the current working directory set to the
# project root. Multiple commands may be specified, and each will execute in
# turn. If any command fails, fetching will stop and the configuration will
# fail
fetch:
commands:
- fetch one
- fetch two
# The version of Yocto that are supported
versions:
# Each version is named here. Any name can be chosen, but the release name
# (e.g. zeus, dunfell, gatesgarth), is recommended
dunfell:
# a short description of the version (optional)
description: Yocto 3.1
# What Yocto release this version is compatible with, as the codename of
# the release (e.g. "zeus", "dunfell", "gatesgarth", etc.). If set to
# "auto" (the default if unspecified), whisk will scan all layers in this
# version to try and automatically figure out an appropriate version
compat: auto
# The path to the OE initialization script for this version
oeinit: "%{WHISK_PROJECT_ROOT}/layers/dunfell/poky/oe-init-build-env"
# Commands to run if the user specifies --fetch to fetch layers and this
# version is active.
fetch:
commands:
- fetch one
- fetch two
# The pyrex configuration for this version. If omitted, pyrex will not be
# used
pyrex:
# The path to the pyrex root for this version. In general, you can share
# the same version of pyrex across multiple different versions and change
# the config file to pull in the pyrex image that matches one of the
# SANITY_TESTED_DISTROS
root: "%{WHISK_PROJECT_ROOT}/layers/meta-pyrex"
# The path to the pyrex configuration file to use for this version
conf: "%{WHISK_PROJECT_ROOT}/layers/dunfell/pyrex.ini"
# A dictionary where additional annotations may be placed. Whisk
# ignores anything in this field (optional)
tags: {}
# The layer collections supported by this version. The order is preserved,
# so layers will added to BBLAYERS in the same order as listed here.
layers:
# The name of the layer collection, as referenced by a product. You
# should keep the names of similar layer collections the same across
# multiple different Yocto versions, as it makes it easier to migrate a
# product to a newer version
- name: oe-core
# The list of layers in this collection. Note that a layer collection
# is allowed to have multiple layers
paths:
- "%{WHISK_PROJECT_ROOT}/layers/dunfell/poky/meta"
# Commands to run if the user specifies --fetch to fetch layers and
# this layer is required by a configured product.
fetch:
commands:
- git submodule update --init layers/dunfell/poky
# A list of individual strings which should be inserted into BBMASK
# for any product which puts this layer collection's name into its
# layers list.
#
# Customarily, each element in this list would be expected to be
# phrased starting from the project root.
bbmask:
- "%{WHISK_PROJECT_ROOT}/layers/dunfell/poky/meta-poky/recipes-core/tiny-init"
# A dictionary where additional annotations may be placed. Whisk
# ignores anything in this field (optional)
tags: {}
- name: mingw
paths:
- "%{WHISK_PROJECT_ROOT}/layers/dunfell/meta-mingw"
fetch:
commands:
- git submodule update --init layers/dunfell/meta-mingw
zeus:
description: Yocto 3.0
oeinit: "%{WHISK_PROJECT_ROOT}/layers/zeus/poky/oe-init-build-env"
pyrex:
root: "%{WHISK_PROJECT_ROOT}/layers/meta-pyrex"
conf: "%{WHISK_PROJECT_ROOT}/layers/dunfell/pyrex.ini"
layers:
- name: oe-core
paths:
- "%{WHISK_PROJECT_ROOT}/layers/zeus/poky/meta"
# The build modes that are supported
modes:
internal:
# A short description of the build mode (optional)
description: Engineering build for internal development
# A fragment that will be directly written into 'site.conf' when this mode
# is used (optional)
conf: |
# Mode placeholder
# A dictionary where additional annotations may be placed. Whisk
# ignores anything in this field (optional)
tags: {}
release:
description: Release build for public release
conf: |
# Mode placeholder
sites:
roaming:
# A short description of the build site (optional)
description: Roaming outside an office
# A fragment that will be directly written into 'site.conf' when this site
# is used (optional)
conf: |
# Site placeholder
# The core configuration. This defines how the base bitbake configuration (e.g.
# outside of any multiconfigs) behaves
core:
# The list of layer collections that should be included in the base
# configuration. Note that all versions *must* provide a layer collection
# with the name of each collection listed here, or else it would be
# impossible to use the base configuration (and thus any configuration).
layers:
- oe-core
# A fragment that will be directly written into 'bblayers.conf' (optional)
layerconf: |
# placeholder
# A fragment that will be directly written into 'site.conf' (optional)
conf: |
MACHINE ?= "qemux86"
DISTRO ?= "poky"
# Defines products that can be built
products:
qemux86-64:
# A short description of the product. This is what shows up when user asks
# for help, so it should try and help the distinguish products,
# particularly if you use a lot of codenames (optional)
description: A test qemux86-64 product
# The default version that this product will build with if unspecified, or
# if the user specifies the default should be used. The user can force a
# product to use a different version if they are feeling adventurous
default_version: dunfell
# The list of layer collections that should be used for this this product
layers:
- oe-core
# Indicates whether the generated Yocto configuration should use a
# traditional layout based only on local.conf/site.conf, or a configuration
# based on multiconfig. Default value is true.
multiconfig_enabled: true
# The list of additional multiconfigs that should be enabled when this
# product is configured. The product multiconfig (i.e. "product-$NAME") is
# always enabled when the product is included, but you may specify
# additional ones to activate when the product is configured (e.g. if the
# product has firmware built with a different multiconfig). (optional)
#
# This list must not have any elements if multiconfig_enabled is set to
# false.
multiconfigs: []
# The list of default build targets that should be built when this product
# is configured. Note that you are not restricted to building a target from
# any specific multiconfig, so you must use the "mc:..." bitbake syntax to
# build from a specific multiconfig. In particular, you will probably want
# most of your entries to to be prefixed with "mc:product-$NAME" to make
# them build in this products multiconfig (optional)
targets:
- "mc:product-qemux86-64:core-image-minimal"
# A fragment that will be directly written into the product multiconfig
# (optional)
conf: |
MACHINE = "qemux86-64"
DISTRO = "poky"
# A dictionary where additional annotations may be placed. Whisk
# ignores anything in this field (optional)
tags: {}
qemuarm:
description: A test qemuarm product
default_version: dunfell
layers:
- oe-core
targets:
- mc:product-qemuarm:core-image-minimal
conf: |
MACHINE = "qemuarm"
DISTRO = "poky"
qemuarm-without-multiconfig:
description: A test qemuarm product, built without using multiconfig
default_version: dunfell
layers:
- oe-core
multiconfig_enabled: false
targets:
- core-image-minimal
conf: |
MACHINE = "qemuarm"
DISTRO = "poky"