mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02:00
d2523d535f
Fixes [YOCTO #8584] This fix essentially had to document how to add the API documentation to the standard SDK. The fix required adding a new appendix to the SDK manual on how to customize that standard SDK. I could not put just one topic in a new appendix so I also added a sub-section on how to add indidual packages to the standard SDK. Other changes here were the introduction of a new file for the new appendix, updated the mega-manual.xml file so that it would include the new chapter when the MM was built. Finally, I added some cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the distro features section on the api-documentation bullet. (From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
64 lines
2.4 KiB
XML
64 lines
2.4 KiB
XML
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
|
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
|
|
|
|
<appendix id='sdk-appendix-customizing-standard'>
|
|
|
|
<title>Customizing the Standard SDK</title>
|
|
|
|
<para>
|
|
This appendix presents customizations you can apply to the standard SDK.
|
|
</para>
|
|
|
|
<section id='sdk-adding-individual-packages'>
|
|
<title>Adding Individual Packages to the Standard SDK</title>
|
|
|
|
<para>
|
|
When you build a standard SDK using the
|
|
<filename>bitbake -c populate_sdk</filename>, a default set of
|
|
packages is included in the resulting SDK.
|
|
The
|
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink>
|
|
and
|
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>
|
|
variables contol the set of packages adding to the SDK.
|
|
</para>
|
|
|
|
<para>
|
|
If you want to add individual packages to the toolchain that runs on
|
|
the host, simply add those packages to the
|
|
<filename>TOOLCHAIN_HOST_TASK</filename> variable.
|
|
Similarly, if you want to add packages to the default set that is
|
|
part of the toolchain that runs on the target, add the packages to the
|
|
<filename>TOOLCHAIN_TARGET_TASK</filename> variable.
|
|
</para>
|
|
</section>
|
|
|
|
<section id='adding-api-documentation-to-the-standard-sdk'>
|
|
<title>Adding API Documentation to the Standard SDK</title>
|
|
|
|
<para>
|
|
You might want to include documentation as part of the standard SDK.
|
|
For example, you might want the API documentation to be built and
|
|
included with the SDK.
|
|
You can include API documentation as well as any other documentation
|
|
with the standard SDK by setting the
|
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></ulink>
|
|
and
|
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink>
|
|
variables:
|
|
<literallayout class='monospaced'>
|
|
SDKIMAGE_FEATURES = "doc-pkgs"
|
|
DISTRO_FEATURES = "api-documentation"
|
|
</literallayout>
|
|
Setting these variables as shown here causes the OpenEmbedded build
|
|
system to build the documentation and then include it in the
|
|
standard SDK.
|
|
</para>
|
|
</section>
|
|
|
|
</appendix>
|
|
<!--
|
|
vim: expandtab tw=80 ts=4
|
|
-->
|