summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-11-18 13:11:53 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-11-23 11:10:35 +0000
commit8028d253a078f3abeb9b6654a366accc06274e09 (patch)
tree04bf361f0370faddae2b0b64e1031bbce098a18f
parentaa45fe52e9ab61e26f23dd7fc5cf8fed0edc765a (diff)
downloadpoky-8028d253a078f3abeb9b6654a366accc06274e09.tar.gz
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>
-rw-r--r--documentation/sdk-manual/sdk-appendix-customizing-standard.xml23
1 files changed, 9 insertions, 14 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-customizing-standard.xml b/documentation/sdk-manual/sdk-appendix-customizing-standard.xml
index fd903e38e5..f20891c80d 100644
--- a/documentation/sdk-manual/sdk-appendix-customizing-standard.xml
+++ b/documentation/sdk-manual/sdk-appendix-customizing-standard.xml
@@ -21,7 +21,7 @@
21 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink> 21 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></ulink>
22 and 22 and
23 <ulink url='&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></ulink> 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. 24 variables control the set of packages adding to the SDK.
25 </para> 25 </para>
26 26
27 <para> 27 <para>
@@ -38,22 +38,17 @@
38 <title>Adding API Documentation to the Standard SDK</title> 38 <title>Adding API Documentation to the Standard SDK</title>
39 39
40 <para> 40 <para>
41 You might want to include documentation as part of the standard SDK. 41 You can include API documentation as well as any other
42 For example, you might want the API documentation to be built and 42 documentation provided by recipes with the standard SDK by
43 included with the SDK. 43 adding "api-documentation" to the
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> 44 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink>
49 variables: 45 variable:
50 <literallayout class='monospaced'> 46 <literallayout class='monospaced'>
51 SDKIMAGE_FEATURES = "doc-pkgs" 47 DISTRO_FEATURES_append = " api-documentation"
52 DISTRO_FEATURES = "api-documentation"
53 </literallayout> 48 </literallayout>
54 Setting these variables as shown here causes the OpenEmbedded build 49 Setting this variable as shown here causes the OpenEmbedded build
55 system to build the documentation and then include it in the 50 system to build the documentation and then include it in the standard
56 standard SDK. 51 SDK.
57 </para> 52 </para>
58</section> 53</section>
59 54