diff options
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index 93cd45d456..1549d90357 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
@@ -211,6 +211,40 @@ | |||
211 | </para> | 211 | </para> |
212 | 212 | ||
213 | <para> | 213 | <para> |
214 | When you run this script, your Yocto Project environment is set | ||
215 | up, a | ||
216 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
217 | is created, your working directory becomes the Build Directory, | ||
218 | and you are presented with a list of common BitBake targets. | ||
219 | Here is an example: | ||
220 | <literallayout class='monospaced'> | ||
221 | $ source oe-init-build-env | ||
222 | |||
223 | ### Shell environment set up for builds. ### | ||
224 | |||
225 | You can now run 'bitbake <target>' | ||
226 | |||
227 | Common targets are: | ||
228 | core-image-minimal | ||
229 | core-image-sato | ||
230 | meta-toolchain | ||
231 | adt-installer | ||
232 | meta-ide-support | ||
233 | |||
234 | You can also run generated qemu images with a command like 'runqemu qemux86' | ||
235 | </literallayout> | ||
236 | The script gets its default list of common targets from the | ||
237 | <filename>conf-notes.txt</filename> file, which is found in the | ||
238 | <filename>meta-yocto</filename> directory within the | ||
239 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | ||
240 | Should you have custom distributions, it is very easy to modify | ||
241 | this configuration file to include your targets for your | ||
242 | distribution. | ||
243 | Simply edit the list within the file and when you run the | ||
244 | environment setup script you see your customized list of targets. | ||
245 | </para> | ||
246 | |||
247 | <para> | ||
214 | By default, running this script without a | 248 | By default, running this script without a |
215 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 249 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
216 | argument creates the <filename>build</filename> directory | 250 | argument creates the <filename>build</filename> directory |
@@ -284,6 +318,42 @@ | |||
284 | </para> | 318 | </para> |
285 | 319 | ||
286 | <para> | 320 | <para> |
321 | When you run this script, your Yocto Project environment is set | ||
322 | up, a | ||
323 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
324 | is created, your working directory becomes the Build Directory, | ||
325 | and you are presented with a list of common BitBake targets. | ||
326 | Here is an example: | ||
327 | <literallayout class='monospaced'> | ||
328 | $ source oe-init-build-env-memres | ||
329 | No port specified, using dynamically selected port | ||
330 | |||
331 | ### Shell environment set up for builds. ### | ||
332 | |||
333 | You can now run 'bitbake <target>' | ||
334 | |||
335 | Common targets are: | ||
336 | core-image-minimal | ||
337 | core-image-sato | ||
338 | meta-toolchain | ||
339 | adt-installer | ||
340 | meta-ide-support | ||
341 | |||
342 | You can also run generated qemu images with a command like 'runqemu qemux86' | ||
343 | Bitbake server started on demand as needed, use bitbake -m to shut it down | ||
344 | </literallayout> | ||
345 | The script gets its default list of common targets from the | ||
346 | <filename>conf-notes.txt</filename> file, which is found in the | ||
347 | <filename>meta-yocto</filename> directory within the | ||
348 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | ||
349 | Should you have custom distributions, it is very easy to modify | ||
350 | this configuration file to include your targets for your | ||
351 | distribution. | ||
352 | Simply edit the list within the file and when you run the | ||
353 | environment setup script you see your customized list of targets. | ||
354 | </para> | ||
355 | |||
356 | <para> | ||
287 | By default, running this script without a | 357 | By default, running this script without a |
288 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 358 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
289 | argument creates a build directory named | 359 | argument creates a build directory named |