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

sdk-manual: Updated the section on adding docs to standard SDK 

Fixes [YOCTO #8584]

Made some edits to tighten this down and make it more efficient.

(From yocto-docs rev: d5a37b77fa5c8df766248849601ca229502bb4ab)

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-18 13:11:53 -08:00 committed by Richard Purdie
parent aa45fe52e9
commit 8028d253a0
1 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
documentation/sdk-manual/sdk-appendix-customizing-standard.xml
View File

@ -21,7 +21,7 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink>
and and
<ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink> <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. variables control the set of packages adding to the SDK.
</para> </para>
<para> <para>
@ -38,22 +38,17 @@
<title>Adding API Documentation to the Standard SDK</title> <title>Adding API Documentation to the Standard SDK</title>
<para> <para>
You might want to include documentation as part of the standard SDK. You can include API documentation as well as any other
For example, you might want the API documentation to be built and documentation provided by recipes with the standard SDK by
included with the SDK. adding "api-documentation" to the
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> <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink>
variables: variable:
<literallayout class='monospaced'> <literallayout class='monospaced'>
SDKIMAGE_FEATURES = "doc-pkgs" DISTRO_FEATURES_append = " api-documentation"
DISTRO_FEATURES = "api-documentation"
</literallayout> </literallayout>
Setting these variables as shown here causes the OpenEmbedded build Setting this variable as shown here causes the OpenEmbedded build
system to build the documentation and then include it in the system to build the documentation and then include it in the standard
standard SDK. SDK.
</para> </para>
</section> </section>