summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual/sdk-appendix-customizing-standard.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-11-15 09:40:34 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-11-16 10:38:42 +0000
commitd2523d535f2ed7a5e76f754087cd6256d3483db3 (patch)
tree26372464e682f4ba84c6770ddffd179ec15d05a7 /documentation/sdk-manual/sdk-appendix-customizing-standard.xml
parent78aa906c2e9f30f6e06c4008059e42d9d20cf72d (diff)
downloadpoky-d2523d535f2ed7a5e76f754087cd6256d3483db3.tar.gz
documentation: Added new appendix for customizing standard SDK
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>
Diffstat (limited to 'documentation/sdk-manual/sdk-appendix-customizing-standard.xml')
-rw-r--r--documentation/sdk-manual/sdk-appendix-customizing-standard.xml63
1 files changed, 63 insertions, 0 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-customizing-standard.xml b/documentation/sdk-manual/sdk-appendix-customizing-standard.xml
new file mode 100644
index 0000000000..fd903e38e5
--- /dev/null
+++ b/documentation/sdk-manual/sdk-appendix-customizing-standard.xml
@@ -0,0 +1,63 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<appendix id='sdk-appendix-customizing-standard'>
6
7<title>Customizing the Standard SDK</title>
8
9<para>
10 This appendix presents customizations you can apply to the standard SDK.
11</para>
12
13<section id='sdk-adding-individual-packages'>
14 <title>Adding Individual Packages to the Standard SDK</title>
15
16 <para>
17 When you build a standard SDK using the
18 <filename>bitbake -c populate_sdk</filename>, a default set of
19 packages is included in the resulting SDK.
20 The
21 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink>
22 and
23 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink>
24 variables contol the set of packages adding to the SDK.
25 </para>
26
27 <para>
28 If you want to add individual packages to the toolchain that runs on
29 the host, simply add those packages to the
30 <filename>TOOLCHAIN_HOST_TASK</filename> variable.
31 Similarly, if you want to add packages to the default set that is
32 part of the toolchain that runs on the target, add the packages to the
33 <filename>TOOLCHAIN_TARGET_TASK</filename> variable.
34 </para>
35</section>
36
37<section id='adding-api-documentation-to-the-standard-sdk'>
38 <title>Adding API Documentation to the Standard SDK</title>
39
40 <para>
41 You might want to include documentation as part of the standard SDK.
42 For example, you might want the API documentation to be built and
43 included with the SDK.
44 You can include API documentation as well as any other documentation
45 with the standard SDK by setting the
46 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></ulink>
47 and
48 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink>
49 variables:
50 <literallayout class='monospaced'>
51 SDKIMAGE_FEATURES = "doc-pkgs"
52 DISTRO_FEATURES = "api-documentation"
53 </literallayout>
54 Setting these variables as shown here causes the OpenEmbedded build
55 system to build the documentation and then include it in the
56 standard SDK.
57 </para>
58</section>
59
60</appendix>
61<!--
62vim: expandtab tw=80 ts=4
63-->