sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2016-11-15 09:40:34 -08:00 committed by Richard Purdie
parent 78aa906c2e
commit d2523d535f
5 changed files with 81 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/mega-manual/mega-manual.xml
View File

@ -125,6 +125,8 @@
xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-obtain.xml"/>
<xi:include
xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing.xml"/>
<xi:include
xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-customizing-standard.xml"/>
<xi:include
xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-mars.xml"/>

4
documentation/ref-manual/ref-features.xml
View File

@ -149,6 +149,10 @@
when the
<filename>bitbake -c populate_sdk</filename> command
is used.
See the
"<ulink url='&YOCTO_DOCS_SDK_URL;#adding-api-documentation-to-the-standard-sdk'>Adding API Documentation to the Standard SDK</ulink>"
section in the Yocto Project Software Development Kit (SDK)
Developer's Guide for more information.
</para></listitem>
<listitem><para><emphasis>bluetooth:</emphasis> Include
bluetooth support (integrated BT only).</para></listitem>

10
documentation/ref-manual/ref-variables.xml
View File

@ -14426,6 +14426,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</literallayout>
In this case, a default list of packages is set in this
variable, but you can add additional packages to the list.
See the
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-adding-individual-packages'>Adding Individual Packages to the Standard SDK</ulink>"
section in the Yocto Project Software Development Kit (SDK)
Developer's Guide for more information.
</para>
<para>
@ -14477,6 +14481,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
uses when it creates the target part of an SDK
(i.e. the part built for the target hardware), which
includes libraries and headers.
Use this variable to add individual packages to the
part of the SDK that runs on the target.
See the
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-adding-individual-packages'>Adding Individual Packages to the Standard SDK</ulink>"
section in the Yocto Project Software Development Kit (SDK)
Developer's Guide for more information.
</para>
<para>

63
documentation/sdk-manual/sdk-appendix-customizing-standard.xml Normal file
View File

@ -0,0 +1,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
-->

2
documentation/sdk-manual/sdk-manual.xml
View File

@ -76,6 +76,8 @@
<xi:include href="sdk-appendix-customizing.xml"/>
<xi:include href="sdk-appendix-customizing-standard.xml"/>
<xi:include href="sdk-appendix-mars.xml"/>
<!-- <index id='index'>