diff options
| -rw-r--r-- | documentation/Makefile | 5 | ||||
| -rw-r--r-- | documentation/mega-manual/figures/source-fetching.png | bin | 0 -> 37445 bytes | |||
| -rw-r--r-- | documentation/ref-manual/figures/source-fetching.png | bin | 0 -> 37445 bytes | |||
| -rw-r--r-- | documentation/ref-manual/technical-details.xml | 71 |
4 files changed, 74 insertions, 2 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index e3a0db4c22..90efc0542b 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
| @@ -198,7 +198,8 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png figures | |||
| 198 | figures/sched-wakeup-profile.png figures/sysprof-callers.png \ | 198 | figures/sched-wakeup-profile.png figures/sysprof-callers.png \ |
| 199 | figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png figures/cross-development-toolchains.png \ | 199 | figures/sysprof-copy-from-user.png figures/sysprof-copy-to-user.png figures/cross-development-toolchains.png \ |
| 200 | figures/yocto-environment-ref.png figures/user-configuration.png figures/source-input.png \ | 200 | figures/yocto-environment-ref.png figures/user-configuration.png figures/source-input.png \ |
| 201 | figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png | 201 | figures/package-feeds.png figures/layer-input.png figures/images.png figures/sdk.png \ |
| 202 | figures/source-fetching.png | ||
| 202 | endif | 203 | endif |
| 203 | 204 | ||
| 204 | MANUALS = $(DOC)/$(DOC).html | 205 | MANUALS = $(DOC)/$(DOC).html |
| @@ -215,7 +216,7 @@ TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ | |||
| 215 | figures/cross-development-toolchains.png figures/layer-input.png \ | 216 | figures/cross-development-toolchains.png figures/layer-input.png \ |
| 216 | figures/package-feeds.png figures/source-input.png \ | 217 | figures/package-feeds.png figures/source-input.png \ |
| 217 | figures/user-configuration.png figures/yocto-environment-ref.png \ | 218 | figures/user-configuration.png figures/yocto-environment-ref.png \ |
| 218 | figures/images.png figures/sdk.png | 219 | figures/images.png figures/sdk.png figures/source-fetching.png |
| 219 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse | 220 | MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf $(DOC)/eclipse |
| 220 | FIGURES = figures | 221 | FIGURES = figures |
| 221 | STYLESHEET = $(DOC)/*.css | 222 | STYLESHEET = $(DOC)/*.css |
diff --git a/documentation/mega-manual/figures/source-fetching.png b/documentation/mega-manual/figures/source-fetching.png new file mode 100644 index 0000000000..ff8414280b --- /dev/null +++ b/documentation/mega-manual/figures/source-fetching.png | |||
| Binary files differ | |||
diff --git a/documentation/ref-manual/figures/source-fetching.png b/documentation/ref-manual/figures/source-fetching.png new file mode 100644 index 0000000000..ff8414280b --- /dev/null +++ b/documentation/ref-manual/figures/source-fetching.png | |||
| Binary files differ | |||
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 400bbd6e4e..a3dd6f0cb0 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
| @@ -961,6 +961,77 @@ | |||
| 961 | </itemizedlist> | 961 | </itemizedlist> |
| 962 | </para> | 962 | </para> |
| 963 | </section> | 963 | </section> |
| 964 | |||
| 965 | <section id='bitbake-dev-environment'> | ||
| 966 | <title>BitBake</title> | ||
| 967 | |||
| 968 | <para> | ||
| 969 | The OpenEmbedded build system uses BitBake to produce images. | ||
| 970 | You can see from the | ||
| 971 | <link linkend='a-closer-look-at-the-yocto-project-development-environment'>Yocto Project Development Environment</link> | ||
| 972 | figure, the BitBake area consists of several functional areas. | ||
| 973 | This section takes a closer look at each of those areas. | ||
| 974 | </para> | ||
| 975 | |||
| 976 | <section id='source-fetching-dev-environment'> | ||
| 977 | <title>Source Fetching</title> | ||
| 978 | |||
| 979 | <para> | ||
| 980 | The first stages of building a recipe are to fetch and unpack | ||
| 981 | the source code: | ||
| 982 | <imagedata fileref="figures/source-fetching.png" align="center" width="6in" depth="4in" /> | ||
| 983 | </para> | ||
| 984 | |||
| 985 | <para> | ||
| 986 | The <filename>do_fetch</filename> and | ||
| 987 | <filename>do_unpack</filename> tasks fetch the source files | ||
| 988 | and unpack them into a working directory. | ||
| 989 | By default, everything is accomplished in the | ||
| 990 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | ||
| 991 | which has a defined structure. | ||
| 992 | For additional general information on the Build Directory, | ||
| 993 | see the | ||
| 994 | "<link linkend='structure-core-build'><filename>build/</filename></link>" | ||
| 995 | section. | ||
| 996 | </para> | ||
| 997 | |||
| 998 | <para> | ||
| 999 | Unpacked source source files are pointed to by the | ||
| 1000 | <link linkend='var-S'><filename>S</filename></link> variable. | ||
| 1001 | Each recipe has an area in the Build Directory where the | ||
| 1002 | unpacked source code resides. | ||
| 1003 | The name of directory for any given recipe is defined from | ||
| 1004 | several different variables. | ||
| 1005 | You can see the variables that define these directories | ||
| 1006 | by looking at the figure: | ||
| 1007 | <itemizedlist> | ||
| 1008 | <listitem><para><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> | ||
| 1009 | </para></listitem> | ||
| 1010 | <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link> | ||
| 1011 | </para></listitem> | ||
| 1012 | <listitem><para><link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link> | ||
| 1013 | </para></listitem> | ||
| 1014 | <listitem><para><link linkend='var-PN'><filename>PN</filename></link> | ||
| 1015 | </para></listitem> | ||
| 1016 | <listitem><para><link linkend='var-PV'><filename>PV</filename></link> | ||
| 1017 | </para></listitem> | ||
| 1018 | <listitem><para><link linkend='var-PR'><filename>PR</filename></link> | ||
| 1019 | </para></listitem> | ||
| 1020 | <listitem><para><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> | ||
| 1021 | </para></listitem> | ||
| 1022 | <listitem><para><link linkend='var-S'><filename>S</filename></link> | ||
| 1023 | </para></listitem> | ||
| 1024 | </itemizedlist> | ||
| 1025 | </para> | ||
| 1026 | |||
| 1027 | <para> | ||
| 1028 | Briefly, the <filename>S</filename> directory contains the | ||
| 1029 | unpacked source files for a recipe. | ||
| 1030 | The <filename>WORKDIR</filename> directory is where all the | ||
| 1031 | building goes on for a given recipe. | ||
| 1032 | </para> | ||
| 1033 | </section> | ||
| 1034 | </section> | ||
| 964 | </section> | 1035 | </section> |
| 965 | 1036 | ||
| 966 | <section id="cross-development-toolchain-generation"> | 1037 | <section id="cross-development-toolchain-generation"> |
