diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2016-11-15 09:40:34 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-11-16 10:38:42 +0000 |
commit | d2523d535f2ed7a5e76f754087cd6256d3483db3 (patch) | |
tree | 26372464e682f4ba84c6770ddffd179ec15d05a7 /documentation | |
parent | 78aa906c2e9f30f6e06c4008059e42d9d20cf72d (diff) | |
download | poky-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')
-rw-r--r-- | documentation/mega-manual/mega-manual.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-features.xml | 4 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 10 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-appendix-customizing-standard.xml | 63 | ||||
-rw-r--r-- | documentation/sdk-manual/sdk-manual.xml | 2 |
5 files changed, 81 insertions, 0 deletions
diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index c16e92861a..eba8b8d74c 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml | |||
@@ -126,6 +126,8 @@ | |||
126 | <xi:include | 126 | <xi:include |
127 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing.xml"/> | 127 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing.xml"/> |
128 | <xi:include | 128 | <xi:include |
129 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing-standard.xml"/> | ||
130 | <xi:include | ||
129 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-mars.xml"/> | 131 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-mars.xml"/> |
130 | 132 | ||
131 | <!-- Includes bsp-guide title image and then bsp-guide chapters --> | 133 | <!-- Includes bsp-guide title image and then bsp-guide chapters --> |
diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml index 03ff9ad251..282a517191 100644 --- a/documentation/ref-manual/ref-features.xml +++ b/documentation/ref-manual/ref-features.xml | |||
@@ -149,6 +149,10 @@ | |||
149 | when the | 149 | when the |
150 | <filename>bitbake -c populate_sdk</filename> command | 150 | <filename>bitbake -c populate_sdk</filename> command |
151 | is used. | 151 | is used. |
152 | See the | ||
153 | "<ulink url='&YOCTO_DOCS_SDK_URL;#adding-api-documentation-to-the-standard-sdk'>Adding API Documentation to the Standard SDK</ulink>" | ||
154 | section in the Yocto Project Software Development Kit (SDK) | ||
155 | Developer's Guide for more information. | ||
152 | </para></listitem> | 156 | </para></listitem> |
153 | <listitem><para><emphasis>bluetooth:</emphasis> Include | 157 | <listitem><para><emphasis>bluetooth:</emphasis> Include |
154 | bluetooth support (integrated BT only).</para></listitem> | 158 | bluetooth support (integrated BT only).</para></listitem> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index f0384a8443..9d6fab0c94 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -14426,6 +14426,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
14426 | </literallayout> | 14426 | </literallayout> |
14427 | In this case, a default list of packages is set in this | 14427 | In this case, a default list of packages is set in this |
14428 | variable, but you can add additional packages to the list. | 14428 | variable, but you can add additional packages to the list. |
14429 | See the | ||
14430 | "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-adding-individual-packages'>Adding Individual Packages to the Standard SDK</ulink>" | ||
14431 | section in the Yocto Project Software Development Kit (SDK) | ||
14432 | Developer's Guide for more information. | ||
14429 | </para> | 14433 | </para> |
14430 | 14434 | ||
14431 | <para> | 14435 | <para> |
@@ -14477,6 +14481,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
14477 | uses when it creates the target part of an SDK | 14481 | uses when it creates the target part of an SDK |
14478 | (i.e. the part built for the target hardware), which | 14482 | (i.e. the part built for the target hardware), which |
14479 | includes libraries and headers. | 14483 | includes libraries and headers. |
14484 | Use this variable to add individual packages to the | ||
14485 | part of the SDK that runs on the target. | ||
14486 | See the | ||
14487 | "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-adding-individual-packages'>Adding Individual Packages to the Standard SDK</ulink>" | ||
14488 | section in the Yocto Project Software Development Kit (SDK) | ||
14489 | Developer's Guide for more information. | ||
14480 | </para> | 14490 | </para> |
14481 | 14491 | ||
14482 | <para> | 14492 | <para> |
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 | <!-- | ||
62 | vim: expandtab tw=80 ts=4 | ||
63 | --> | ||
diff --git a/documentation/sdk-manual/sdk-manual.xml b/documentation/sdk-manual/sdk-manual.xml index 6c72a03464..1b4e198e6e 100644 --- a/documentation/sdk-manual/sdk-manual.xml +++ b/documentation/sdk-manual/sdk-manual.xml | |||
@@ -76,6 +76,8 @@ | |||
76 | 76 | ||
77 | <xi:include href="sdk-appendix-customizing.xml"/> | 77 | <xi:include href="sdk-appendix-customizing.xml"/> |
78 | 78 | ||
79 | <xi:include href="sdk-appendix-customizing-standard.xml"/> | ||
80 | |||
79 | <xi:include href="sdk-appendix-mars.xml"/> | 81 | <xi:include href="sdk-appendix-mars.xml"/> |
80 | 82 | ||
81 | <!-- <index id='index'> | 83 | <!-- <index id='index'> |