diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-07-15 08:30:15 +0300 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-08-13 13:18:40 +0100 |
| commit | cb66b6e1a28ae20261ea2d02c638b0a8590ab8b2 (patch) | |
| tree | bab3669f48a4f9d0df4218f567bd40732e64376e | |
| parent | c7ac8851c8c1d21a3d49fb9aa58c531dfaf85fd6 (diff) | |
| download | poky-cb66b6e1a28ae20261ea2d02c638b0a8590ab8b2.tar.gz | |
ref-manual: Review comments added.
Fixes [YOCTO #2808]
Applied review comments from Paul Eggleton on the user configuration
and the layers section. Changes applied to the figure for the
user configuration section as well.
(From yocto-docs rev: b05af4b740f0daf3d6c59acf71c362decba2a176)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | documentation/ref-manual/figures/user-configuration.png | bin | 24982 -> 24734 bytes | |||
| -rw-r--r-- | documentation/ref-manual/technical-details.xml | 48 |
2 files changed, 28 insertions, 20 deletions
diff --git a/documentation/ref-manual/figures/user-configuration.png b/documentation/ref-manual/figures/user-configuration.png index 5f49e2fccf..b9425a9e50 100644 --- a/documentation/ref-manual/figures/user-configuration.png +++ b/documentation/ref-manual/figures/user-configuration.png | |||
| Binary files differ | |||
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 77c1ba84e4..f35b296fe5 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
| @@ -184,13 +184,19 @@ | |||
| 184 | <listitem><para><emphasis>Source Files:</emphasis> | 184 | <listitem><para><emphasis>Source Files:</emphasis> |
| 185 | Upstream releases, local projects, and SCMs.</para></listitem> | 185 | Upstream releases, local projects, and SCMs.</para></listitem> |
| 186 | <listitem><para><emphasis>Build System:</emphasis> | 186 | <listitem><para><emphasis>Build System:</emphasis> |
| 187 | Processes inside the BitBake "box". | 187 | Processes under the control of BitBake. |
| 188 | This block expands on how BitBake fetches source, applies | 188 | This block expands on how BitBake fetches source, applies |
| 189 | patches, completes compilation, analyzes output for package | 189 | patches, completes compilation, analyzes output for package |
| 190 | generation, creates and tests packages, generates images, and | 190 | generation, creates and tests packages, generates images, and |
| 191 | generates cross-development tools.</para></listitem> | 191 | generates cross-development tools.</para></listitem> |
| 192 | <listitem><para><emphasis>Package Feeds:</emphasis> | 192 | <listitem><para><emphasis>Package Feeds:</emphasis> |
| 193 | Package feeds into the BitBake process.</para></listitem> | 193 | Directories containing output packages (rpm, deb or ipk), |
| 194 | which are subsequently used in the construction of an image or | ||
| 195 | SDK, produced by the build system. | ||
| 196 | These feeds can also be copied and shared using a web server or | ||
| 197 | other means to facilitate extending or updating existing | ||
| 198 | images on devices at runtime if runtime package management is | ||
| 199 | enabled.</para></listitem> | ||
| 194 | <listitem><para><emphasis>Images:</emphasis> | 200 | <listitem><para><emphasis>Images:</emphasis> |
| 195 | Images produced by the development process. | 201 | Images produced by the development process. |
| 196 | Where do they go? | 202 | Where do they go? |
| @@ -269,12 +275,11 @@ | |||
| 269 | <para> | 275 | <para> |
| 270 | Because the Poky repository is fundamentally an aggregation of | 276 | Because the Poky repository is fundamentally an aggregation of |
| 271 | existing repositories, some users might be familiar with running | 277 | existing repositories, some users might be familiar with running |
| 272 | the <filename>oe-init-build-env</filename> script in the context | 278 | the <filename>oe-init-build-env</filename> script in the context of |
| 273 | of the OpenEmbedded development environment, which is outside | 279 | separate OpenEmbedded-Core and BitBake repositories rather than a |
| 274 | of the Yocto Project development environment. | 280 | single Poky repository. |
| 275 | This discussion assumes the script is executed from within a | 281 | This discussion assumes the script is executed from within a cloned |
| 276 | cloned or unpacked version of Poky (i.e. within the Yocto Project | 282 | or unpacked version of Poky. |
| 277 | environment). | ||
| 278 | </para> | 283 | </para> |
| 279 | 284 | ||
| 280 | <para> | 285 | <para> |
| @@ -514,16 +519,16 @@ | |||
| 514 | This area holds configuration files for the | 519 | This area holds configuration files for the |
| 515 | layer (<filename>conf/layer.conf</filename>), | 520 | layer (<filename>conf/layer.conf</filename>), |
| 516 | the distribution | 521 | the distribution |
| 517 | (<filename>conf/distro/<distro<.conf</filename>), | 522 | (<filename>conf/distro/<distro>.conf</filename>), |
| 518 | and any distribution-wide include files. | 523 | and any distribution-wide include files. |
| 519 | </para></listitem> | 524 | </para></listitem> |
| 520 | <listitem><para><emphasis>recipes-*:</emphasis> | 525 | <listitem><para><emphasis>recipes-*:</emphasis> |
| 521 | Recipes and append files that affect common | 526 | Recipes and append files that affect common |
| 522 | functionality across the distribution. | 527 | functionality across the distribution. |
| 523 | This area also can hold common distribution headers, | 528 | This area could include recipes and append files to |
| 524 | initialization files, and | 529 | to add distribution-specific configuration, |
| 525 | <filename><recipe>/files/defconfig</filename> | 530 | initialization scripts, custom image recipes, |
| 526 | files for the distribution.</para></listitem> | 531 | and so forth.</para></listitem> |
| 527 | </itemizedlist> | 532 | </itemizedlist> |
| 528 | </para> | 533 | </para> |
| 529 | </section> | 534 | </section> |
| @@ -535,10 +540,13 @@ | |||
| 535 | The BSP Layer provides machine configurations. | 540 | The BSP Layer provides machine configurations. |
| 536 | Everything in this layer is specific to the machine for which | 541 | Everything in this layer is specific to the machine for which |
| 537 | you are building the image or the SDK. | 542 | you are building the image or the SDK. |
| 538 | BSP Layers have a structure that is followed if they are | 543 | A common structure or form is defined for BSP layers. |
| 539 | considered to be compatible with the Yocto Project. | 544 | You can learn more about this structure in the |
| 540 | For information on the structure, see the | ||
| 541 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. | 545 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. |
| 546 | <note> | ||
| 547 | In order for a BSP layer to be considered compliant with the | ||
| 548 | Yocto Project, it must meet some structural requirements. | ||
| 549 | </note> | ||
| 542 | </para> | 550 | </para> |
| 543 | 551 | ||
| 544 | <para> | 552 | <para> |
| @@ -568,8 +576,8 @@ | |||
| 568 | <title>Software Layer</title> | 576 | <title>Software Layer</title> |
| 569 | 577 | ||
| 570 | <para> | 578 | <para> |
| 571 | The software layer provides the Metadata for your source | 579 | The software layer provides the Metadata for your |
| 572 | code used during the build. | 580 | software packages used during the build. |
| 573 | This layer does not include Metadata that is specific to the | 581 | This layer does not include Metadata that is specific to the |
| 574 | distribution or the machine, which are found in their | 582 | distribution or the machine, which are found in their |
| 575 | respective layers. | 583 | respective layers. |
| @@ -578,8 +586,8 @@ | |||
| 578 | <para> | 586 | <para> |
| 579 | This layer contains any new recipes that your project needs | 587 | This layer contains any new recipes that your project needs |
| 580 | in the form of recipe files. | 588 | in the form of recipe files. |
| 581 | Patch files are stored in the <filename>files</filename> | 589 | If the software layer contains any patch files, they can be |
| 582 | directory. | 590 | stored in a <filename>files</filename> directory. |
| 583 | </para> | 591 | </para> |
| 584 | </section> | 592 | </section> |
| 585 | </section> | 593 | </section> |
