summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual/sdk-appendix-customizing-standard.xml
blob: fd903e38e54ea56ed4d686d93d9e7f5c6f89f92e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<!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
-->