]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
sdk-manual: Updated the section on adding docs to standard SDK
authorScott Rifenbark <srifenbark@gmail.com>
Fri, 18 Nov 2016 21:11:53 +0000 (13:11 -0800)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Thu, 8 Dec 2016 16:36:47 +0000 (16:36 +0000)
Fixes [YOCTO #8584]

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

(From yocto-docs rev: f25c0cf08877b62a6e2523b5d4caa83c008ef004)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation/sdk-manual/sdk-appendix-customizing-standard.xml

index fd903e38e54ea56ed4d686d93d9e7f5c6f89f92e..f20891c80d89ae05e6dbaaae90cfc844daa1f733 100644 (file)
@@ -21,7 +21,7 @@
          <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.
+         variables control the set of packages adding to the SDK.
     </para>
 
     <para>
     <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
+        You can include API documentation as well as any other
+        documentation provided by recipes with the standard SDK by
+        adding "api-documentation" to the
         <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></ulink>
-        variables:
+        variable:
         <literallayout class='monospaced'>
-     SDKIMAGE_FEATURES = "doc-pkgs"
-     DISTRO_FEATURES = "api-documentation"
+     DISTRO_FEATURES_append = " 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.
+        Setting this variable as shown here causes the OpenEmbedded build
+        system to build the documentation and then include it in the standard
+        SDK.
     </para>
 </section>