summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual/overview-manual-concepts.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-05-11 09:08:28 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-05-24 17:16:33 +0100
commitcb244d438af9d1ed623b1b45d3e3fff283c6b1be (patch)
tree0619a9062c6f292aeaaf68427a41e60598522136 /documentation/overview-manual/overview-manual-concepts.xml
parent99c4743469416074cd3a4375a22f07dcef05e000 (diff)
downloadpoky-cb244d438af9d1ed623b1b45d3e3fff283c6b1be.tar.gz
overview-manual: Minor edits to the SDK generation section.
Added the descriptions for the SDK_HOST_MANIFEST and SDK_TARGET_MANIFEST variables. (From yocto-docs rev: 212d6c5b3290016431604e67dfb27a1408ac0463) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/overview-manual/overview-manual-concepts.xml')
-rw-r--r--documentation/overview-manual/overview-manual-concepts.xml134
1 files changed, 74 insertions, 60 deletions
diff --git a/documentation/overview-manual/overview-manual-concepts.xml b/documentation/overview-manual/overview-manual-concepts.xml
index c3e4b457ff..11aadf73e1 100644
--- a/documentation/overview-manual/overview-manual-concepts.xml
+++ b/documentation/overview-manual/overview-manual-concepts.xml
@@ -2048,24 +2048,26 @@
2048 2048
2049 <para> 2049 <para>
2050 In the 2050 In the
2051 <link linkend='general-workflow-figure'>general Yocto Project Development Environment figure</link>, 2051 <link linkend='general-workflow-figure'>general workflow figure</link>,
2052 the output labeled "Application Development SDK" represents an 2052 the output labeled "Application Development SDK" represents an
2053 SDK. 2053 SDK.
2054 The SDK generation process differs depending on whether you 2054 The SDK generation process differs depending on whether you
2055 build a standard SDK (e.g. 2055 build an extensible SDK (e.g.
2056 <filename>bitbake -c populate_sdk</filename> <replaceable>imagename</replaceable>) 2056 <filename>bitbake -c populate_sdk_ext</filename> <replaceable>imagename</replaceable>)
2057 or an extensible SDK (e.g. 2057 or a standard SDK (e.g.
2058 <filename>bitbake -c populate_sdk_ext</filename> <replaceable>imagename</replaceable>). 2058 <filename>bitbake -c populate_sdk</filename> <replaceable>imagename</replaceable>).
2059 This section is going to take a closer look at this output: 2059 This section takes a closer look at this output:
2060 <imagedata fileref="figures/sdk.png" align="center" width="9in" depth="7.25in" /> 2060 <imagedata fileref="figures/sdk.png" align="center" width="9in" depth="7.25in" />
2061 </para> 2061 </para>
2062 2062
2063 <para> 2063 <para>
2064 The specific form of this output is a self-extracting 2064 The specific form of this output is a set of files that
2065 SDK installer (<filename>*.sh</filename>) that, when run, 2065 includes a self-extracting SDK installer
2066 installs the SDK, which consists of a cross-development 2066 (<filename>*.sh</filename>), host and target manifest files,
2067 toolchain, a set of libraries and headers, and an SDK 2067 and files used for SDK testing.
2068 environment setup script. 2068 When the SDK installer file is run, it installs the SDK.
2069 The SDK consists of a cross-development toolchain, a set of
2070 libraries and headers, and an SDK environment setup script.
2069 Running this installer essentially sets up your 2071 Running this installer essentially sets up your
2070 cross-development environment. 2072 cross-development environment.
2071 You can think of the cross-toolchain as the "host" 2073 You can think of the cross-toolchain as the "host"
@@ -2102,55 +2104,13 @@
2102 </note> 2104 </note>
2103 2105
2104 <para> 2106 <para>
2105 Once built, the SDK installers are written out to the 2107 All the output files for an SDK are written to the
2106 <filename>deploy/sdk</filename> folder inside the 2108 <filename>deploy/sdk</filename> folder inside the
2107 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> 2109 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
2108 as shown in the figure at the beginning of this section. 2110 as shown in the previous figure.
2109 Depending on the type of SDK, several variables exist that help 2111 Depending on the type of SDK, several variables exist that help
2110 configure these files. 2112 configure these files.
2111 The following list shows the variables associated with 2113 The following list shows the variables associated with an
2112 a standard SDK:
2113 <itemizedlist>
2114 <listitem><para>
2115 <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink>:
2116 Points to the <filename>deploy</filename>
2117 directory.
2118 </para></listitem>
2119 <listitem><para>
2120 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>:
2121 Specifies the architecture of the machine
2122 on which the cross-development tools are run to
2123 create packages for the target hardware.
2124 </para></listitem>
2125 <listitem><para>
2126 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></ulink>:
2127 Lists the features to include in the "target" part
2128 of the SDK.
2129 </para></listitem>
2130 <listitem><para>
2131 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink>:
2132 Lists packages that make up the host
2133 part of the SDK (i.e. the part that runs on
2134 the <filename>SDKMACHINE</filename>).
2135 When you use
2136 <filename>bitbake -c populate_sdk <replaceable>imagename</replaceable></filename>
2137 to create the SDK, a set of default packages
2138 apply.
2139 This variable allows you to add more packages.
2140 </para></listitem>
2141 <listitem><para>
2142 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>:
2143 Lists packages that make up the target part
2144 of the SDK (i.e. the part built for the
2145 target hardware).
2146 </para></listitem>
2147 <listitem><para>
2148 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKPATH'><filename>SDKPATH</filename></ulink>:
2149 Defines the default SDK installation path offered
2150 by the installation script.
2151 </para></listitem>
2152 </itemizedlist>
2153 This next list, shows the variables associated with an
2154 extensible SDK: 2114 extensible SDK:
2155 <itemizedlist> 2115 <itemizedlist>
2156 <listitem><para> 2116 <listitem><para>
@@ -2166,13 +2126,12 @@
2166 </para></listitem> 2126 </para></listitem>
2167 <listitem><para> 2127 <listitem><para>
2168 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_PKGDATA'><filename>SDK_INCLUDE_PKGDATA</filename></ulink>: 2128 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_PKGDATA'><filename>SDK_INCLUDE_PKGDATA</filename></ulink>:
2169 Specifies whether or not packagedata will be 2129 Specifies whether or not packagedata is included in the
2170 included in the extensible SDK for all recipes in 2130 extensible SDK for all recipes in the "world" target.
2171 the "world" target.
2172 </para></listitem> 2131 </para></listitem>
2173 <listitem><para> 2132 <listitem><para>
2174 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></ulink>: 2133 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></ulink>:
2175 Specifies whether or not the toolchain will be included 2134 Specifies whether or not the toolchain is included
2176 when building the extensible SDK. 2135 when building the extensible SDK.
2177 </para></listitem> 2136 </para></listitem>
2178 <listitem><para> 2137 <listitem><para>
@@ -2194,6 +2153,61 @@
2194 value globally within the extensible SDK configuration. 2153 value globally within the extensible SDK configuration.
2195 </para></listitem> 2154 </para></listitem>
2196 </itemizedlist> 2155 </itemizedlist>
2156 This next list, shows the variables associated with a standard
2157 SDK:
2158 <itemizedlist>
2159 <listitem><para>
2160 <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></ulink>:
2161 Points to the <filename>deploy</filename> directory.
2162 </para></listitem>
2163 <listitem><para>
2164 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKMACHINE'><filename>SDKMACHINE</filename></ulink>:
2165 Specifies the architecture of the machine on which the
2166 cross-development tools are run to create packages for
2167 the target hardware.
2168 </para></listitem>
2169 <listitem><para>
2170 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></ulink>:
2171 Lists the features to include in the "target" part
2172 of the SDK.
2173 </para></listitem>
2174 <listitem><para>
2175 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink>:
2176 Lists packages that make up the host part of the SDK
2177 (i.e. the part that runs on the
2178 <filename>SDKMACHINE</filename>).
2179 When you use
2180 <filename>bitbake -c populate_sdk <replaceable>imagename</replaceable></filename>
2181 to create the SDK, a set of default packages apply.
2182 This variable allows you to add more packages.
2183 </para></listitem>
2184 <listitem><para>
2185 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>:
2186 Lists packages that make up the target part of the SDK
2187 (i.e. the part built for the target hardware).
2188 </para></listitem>
2189 <listitem><para>
2190 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKPATH'><filename>SDKPATH</filename></ulink>:
2191 Defines the default SDK installation path offered by
2192 the installation script.
2193 </para></listitem>
2194 <listitem><para>
2195 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_HOST_MANIFEST'><filename>SDK_HOST_MANIFEST</filename></ulink>:
2196 Lists all the installed packages that make up the host
2197 part of the SDK.
2198 This variable also plays a minor role for extensible
2199 SDK development as well.
2200 However, it is mainly used for the standard SDK.
2201 </para></listitem>
2202 <listitem><para>
2203 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_TARGET_MANIFEST'><filename>SDK_TARGET_MANIFEST</filename></ulink>:
2204 Lists all the installed packages that make up the
2205 target part of the SDK.
2206 This variable also plays a minor role for extensible
2207 SDK development as well.
2208 However, it is mainly used for the standard SDK.
2209 </para></listitem>
2210 </itemizedlist>
2197 </para> 2211 </para>
2198 </section> 2212 </section>
2199 </section> 2213 </section>