From d2523d535f2ed7a5e76f754087cd6256d3483db3 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 15 Nov 2016 09:40:34 -0800 Subject: 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 Signed-off-by: Richard Purdie --- documentation/mega-manual/mega-manual.xml | 2 + documentation/ref-manual/ref-features.xml | 4 ++ documentation/ref-manual/ref-variables.xml | 10 ++++ .../sdk-appendix-customizing-standard.xml | 63 ++++++++++++++++++++++ documentation/sdk-manual/sdk-manual.xml | 2 + 5 files changed, 81 insertions(+) create mode 100644 documentation/sdk-manual/sdk-appendix-customizing-standard.xml (limited to 'documentation') 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 @@ -125,6 +125,8 @@ xmlns:xi="http://www.w3.org/2003/XInclude" href="../sdk-manual/sdk-appendix-obtain.xml"/> + 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 @@ when the bitbake -c populate_sdk command is used. + See the + "Adding API Documentation to the Standard SDK" + section in the Yocto Project Software Development Kit (SDK) + Developer's Guide for more information. bluetooth: Include bluetooth support (integrated BT only). 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" In this case, a default list of packages is set in this variable, but you can add additional packages to the list. + See the + "Adding Individual Packages to the Standard SDK" + section in the Yocto Project Software Development Kit (SDK) + Developer's Guide for more information. @@ -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 + "Adding Individual Packages to the Standard SDK" + section in the Yocto Project Software Development Kit (SDK) + Developer's Guide for more information. 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 @@ + %poky; ] > + + + +Customizing the Standard SDK + + + This appendix presents customizations you can apply to the standard SDK. + + +
+ Adding Individual Packages to the Standard SDK + + + When you build a standard SDK using the + bitbake -c populate_sdk, a default set of + packages is included in the resulting SDK. + The + TOOLCHAIN_HOST_TASK + and + TOOLCHAIN_TARGET_TASK + variables contol the set of packages adding to the SDK. + + + + If you want to add individual packages to the toolchain that runs on + the host, simply add those packages to the + TOOLCHAIN_HOST_TASK 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 + TOOLCHAIN_TARGET_TASK variable. + +
+ +
+ Adding API Documentation to the Standard SDK + + + 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 + SDKIMAGE_FEATURES + and + DISTRO_FEATURES + variables: + + SDKIMAGE_FEATURES = "doc-pkgs" + DISTRO_FEATURES = "api-documentation" + + Setting these variables as shown here causes the OpenEmbedded build + system to build the documentation and then include it in the + standard SDK. + +
+ + + 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 @@ + +