diff options
Diffstat (limited to 'documentation/ref-manual/ref-structure.xml')
-rw-r--r-- | documentation/ref-manual/ref-structure.xml | 59 |
1 files changed, 26 insertions, 33 deletions
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index d2d75932f8..66e58f262d 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
@@ -101,7 +101,7 @@ | |||
101 | </section> | 101 | </section> |
102 | 102 | ||
103 | <section id='handbook'> | 103 | <section id='handbook'> |
104 | <title><filename>documentation</filename></title> | 104 | <title><filename>documentation/</filename></title> |
105 | 105 | ||
106 | <para> | 106 | <para> |
107 | This directory holds the source for the Yocto Project documentation | 107 | This directory holds the source for the Yocto Project documentation |
@@ -109,7 +109,7 @@ | |||
109 | versions of the manuals. | 109 | versions of the manuals. |
110 | Each manual is contained in a sub-folder. | 110 | Each manual is contained in a sub-folder. |
111 | For example, the files for this manual reside in | 111 | For example, the files for this manual reside in |
112 | <filename>ref-manual</filename>. | 112 | the <filename>ref-manual/</filename> directory. |
113 | </para> | 113 | </para> |
114 | </section> | 114 | </section> |
115 | 115 | ||
@@ -179,9 +179,9 @@ | |||
179 | </para> | 179 | </para> |
180 | 180 | ||
181 | <para> | 181 | <para> |
182 | The <filename>scripts</filename> directory has useful scripts that assist contributing | 182 | The <filename>scripts</filename> directory has useful scripts that assist in contributing |
183 | back to the Yocto Project, such as <filename>create_pull_request</filename> and | 183 | back to the Yocto Project, such as <filename>create-pull-request</filename> and |
184 | <filename>send_pull_request</filename>. | 184 | <filename>send-pull-request</filename>. |
185 | </para> | 185 | </para> |
186 | </section> | 186 | </section> |
187 | 187 | ||
@@ -209,7 +209,8 @@ | |||
209 | <para> | 209 | <para> |
210 | By default, running this script without a | 210 | By default, running this script without a |
211 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 211 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
212 | argument creates the <filename>build</filename> directory. | 212 | argument creates the <filename>build</filename> directory |
213 | in your current working directory. | ||
213 | If you provide a Build Directory argument when you | 214 | If you provide a Build Directory argument when you |
214 | <filename>source</filename> the script, you direct the OpenEmbedded | 215 | <filename>source</filename> the script, you direct the OpenEmbedded |
215 | build system to create a Build Directory of your choice. | 216 | build system to create a Build Directory of your choice. |
@@ -346,7 +347,7 @@ | |||
346 | <filename><link linkend='var-MACHINE'>MACHINE</link></filename> | 347 | <filename><link linkend='var-MACHINE'>MACHINE</link></filename> |
347 | for which you want to build, which package types you wish to use | 348 | for which you want to build, which package types you wish to use |
348 | (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), | 349 | (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), |
349 | the location from which you want to downloaded files | 350 | the location from which you want to access downloaded files |
350 | (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>), | 351 | (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>), |
351 | and how you want your host machine to use resources | 352 | and how you want your host machine to use resources |
352 | (<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> | 353 | (<link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> |
@@ -368,9 +369,9 @@ | |||
368 | <para> | 369 | <para> |
369 | The source <filename>local.conf.sample</filename> file used | 370 | The source <filename>local.conf.sample</filename> file used |
370 | depends on the <filename>$TEMPLATECONF</filename> script variable, | 371 | depends on the <filename>$TEMPLATECONF</filename> script variable, |
371 | which defaults to <filename>/meta-yocto/conf</filename> | 372 | which defaults to <filename>meta-yocto/conf</filename> |
372 | when you are building from the Yocto Project development | 373 | when you are building from the Yocto Project development |
373 | environment and defaults to <filename>/meta/conf</filename> when | 374 | environment and defaults to <filename>meta/conf</filename> when |
374 | you are building from the OpenEmbedded Core environment. | 375 | you are building from the OpenEmbedded Core environment. |
375 | Because the script variable points to the source of the | 376 | Because the script variable points to the source of the |
376 | <filename>local.conf.sample</filename> file, this implies that | 377 | <filename>local.conf.sample</filename> file, this implies that |
@@ -387,11 +388,11 @@ | |||
387 | <note> | 388 | <note> |
388 | You can see how the <filename>TEMPLATECONF</filename> variable | 389 | You can see how the <filename>TEMPLATECONF</filename> variable |
389 | is used by looking at the | 390 | is used by looking at the |
390 | <filename>/scripts/oe-setup-builddir</filename> script in the | 391 | <filename>scripts/oe-setup-builddir</filename> script in the |
391 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 392 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
392 | You can find the Yocto Project version of the | 393 | You can find the Yocto Project version of the |
393 | <filename>local.conf.sample</filename> file in the | 394 | <filename>local.conf.sample</filename> file in the |
394 | <filename>/meta-yocto/conf</filename> directory. | 395 | <filename>meta-yocto/conf</filename> directory. |
395 | </note> | 396 | </note> |
396 | </para> | 397 | </para> |
397 | </section> | 398 | </section> |
@@ -424,9 +425,9 @@ | |||
424 | <para> | 425 | <para> |
425 | The source <filename>bblayers.conf.sample</filename> file used | 426 | The source <filename>bblayers.conf.sample</filename> file used |
426 | depends on the <filename>$TEMPLATECONF</filename> script variable, | 427 | depends on the <filename>$TEMPLATECONF</filename> script variable, |
427 | which defaults to <filename>/meta-yocto/conf</filename> | 428 | which defaults to <filename>meta-yocto/conf</filename> |
428 | when you are building from the Yocto Project development | 429 | when you are building from the Yocto Project development |
429 | environment and defaults to <filename>/meta/conf</filename> when | 430 | environment and defaults to <filename>meta/conf</filename> when |
430 | you are building from the OpenEmbedded Core environment. | 431 | you are building from the OpenEmbedded Core environment. |
431 | Because the script variable points to the source of the | 432 | Because the script variable points to the source of the |
432 | <filename>bblayers.conf.sample</filename> file, this implies that | 433 | <filename>bblayers.conf.sample</filename> file, this implies that |
@@ -441,11 +442,11 @@ | |||
441 | values for all <filename>##OEROOT##</filename> values. | 442 | values for all <filename>##OEROOT##</filename> values. |
442 | <note> | 443 | <note> |
443 | You can see how the <filename>TEMPLATECONF</filename> variable | 444 | You can see how the <filename>TEMPLATECONF</filename> variable |
444 | <filename>/scripts/oe-setup-builddir</filename> script in the | 445 | <filename>scripts/oe-setup-builddir</filename> script in the |
445 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 446 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
446 | You can find the Yocto Project version of the | 447 | You can find the Yocto Project version of the |
447 | <filename>bblayers.conf.sample</filename> file in the | 448 | <filename>bblayers.conf.sample</filename> file in the |
448 | <filename>/meta-yocto/conf</filename> directory. | 449 | <filename>meta-yocto/conf</filename> directory. |
449 | </note> | 450 | </note> |
450 | </para> | 451 | </para> |
451 | </section> | 452 | </section> |
@@ -487,7 +488,7 @@ | |||
487 | <title><filename>build/tmp/</filename></title> | 488 | <title><filename>build/tmp/</filename></title> |
488 | 489 | ||
489 | <para> | 490 | <para> |
490 | This directory receives all the OpenEmbedded build system's output. | 491 | This directory receives all of the OpenEmbedded build system's output. |
491 | BitBake creates this directory if it does not exist. | 492 | BitBake creates this directory if it does not exist. |
492 | As a last resort, to clean up a build and start it from scratch (other than the downloads), | 493 | As a last resort, to clean up a build and start it from scratch (other than the downloads), |
493 | you can remove everything in the <filename>tmp</filename> directory or get rid of the | 494 | you can remove everything in the <filename>tmp</filename> directory or get rid of the |
@@ -551,6 +552,15 @@ | |||
551 | </para> | 552 | </para> |
552 | </section> | 553 | </section> |
553 | 554 | ||
555 | <section id='structure-build-tmp-deploy-ipk'> | ||
556 | <title><filename>build/tmp/deploy/ipk/</filename></title> | ||
557 | |||
558 | <para> | ||
559 | This directory receives <filename>.ipk</filename> packages produced by | ||
560 | the build process. | ||
561 | </para> | ||
562 | </section> | ||
563 | |||
554 | <section id='structure-build-tmp-deploy-licenses'> | 564 | <section id='structure-build-tmp-deploy-licenses'> |
555 | <title><filename>build/tmp/deploy/licenses/</filename></title> | 565 | <title><filename>build/tmp/deploy/licenses/</filename></title> |
556 | 566 | ||
@@ -597,14 +607,6 @@ | |||
597 | </para> | 607 | </para> |
598 | </section> | 608 | </section> |
599 | 609 | ||
600 | <section id='structure-build-tmp-deploy-ipk'> | ||
601 | <title><filename>build/tmp/deploy/ipk/</filename></title> | ||
602 | |||
603 | <para> | ||
604 | This directory receives <filename>.ipk</filename> packages produced by | ||
605 | the build process.</para> | ||
606 | </section> | ||
607 | |||
608 | <section id='structure-build-tmp-sysroots'> | 610 | <section id='structure-build-tmp-sysroots'> |
609 | <title><filename>build/tmp/sysroots/</filename></title> | 611 | <title><filename>build/tmp/sysroots/</filename></title> |
610 | 612 | ||
@@ -646,15 +648,6 @@ | |||
646 | </para> | 648 | </para> |
647 | </section> | 649 | </section> |
648 | 650 | ||
649 | <section id='structure-build-tmp-pkgdata'> | ||
650 | <title><filename>build/tmp/pkgdata/</filename></title> | ||
651 | |||
652 | <para> | ||
653 | This directory contains intermediate packaging data that is used later in the packaging process. | ||
654 | For more information, see the "<link linkend='ref-classes-package'>Packaging - package*.bbclass</link>" section. | ||
655 | </para> | ||
656 | </section> | ||
657 | |||
658 | <section id='structure-build-tmp-work'> | 651 | <section id='structure-build-tmp-work'> |
659 | <title><filename>build/tmp/work/</filename></title> | 652 | <title><filename>build/tmp/work/</filename></title> |
660 | 653 | ||