diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-11-20 20:17:33 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-01-04 10:55:00 +0000 |
commit | fa0cb4d34b1073f215fa3c680f2316208739d53d (patch) | |
tree | ba89c1f4289fd6456af4409a6a19caf6548dfb9c /documentation/sdk-manual/sdk-appendix-customizing-standard.rst | |
parent | a038e58f3cd82c56102444bdc5ac76c9f1550a0d (diff) | |
download | poky-fa0cb4d34b1073f215fa3c680f2316208739d53d.tar.gz |
sphinx: import docs
The Yocto Project docs was migrated from Docbook to Sphinx in YP
3.2. This 3.1 is an LTS release, and since 3.1 docs are 'close to'
the docs in 3.2, we agreed to backport sphinx docs onto 3.1.
This first patch brings all changes done in 3.2 until:
7f64574f7 README: include detailed information about sphinx
There are other changes after this commit, but they will be
selectively backported in individual patches.
This patch was generated with the following command:
git cherry-pick -n \
$(git log --reverse --oneline \
ac352ad7f95db7eeacb53c2778caa31800bd7c26..7f64574f7 \
| cut -f1 -d' ')
The following commits were applies in the dunfell docs, but not in
master, so they were first reverted (and squashed into this change). A
commit will reintroduce the content from these patches in the Sphinx
files in a followup patch.
069c27574 Documenation: Prepared for the 3.1.1 release
bd140f0f9 Documentation: Add 3.1.1 version updates missing from previous commit
17cc71a8f Documenation: Prepared for the 3.1.2 release
1a69e2c02 Documenation: Prepared for the 3.1.3 release
8910ac1c7 Documenation: Prepared for the 3.1.4 release
(From yocto-docs rev: c25fe058b88b893b0d146f3ed27320b47cdec236)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/sdk-appendix-customizing-standard.rst')
-rw-r--r-- | documentation/sdk-manual/sdk-appendix-customizing-standard.rst | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-customizing-standard.rst b/documentation/sdk-manual/sdk-appendix-customizing-standard.rst new file mode 100644 index 0000000000..f6f2b6640f --- /dev/null +++ b/documentation/sdk-manual/sdk-appendix-customizing-standard.rst | |||
@@ -0,0 +1,34 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-2.0-UK | ||
2 | |||
3 | **************************** | ||
4 | Customizing the Standard SDK | ||
5 | **************************** | ||
6 | |||
7 | This appendix presents customizations you can apply to the standard SDK. | ||
8 | |||
9 | Adding Individual Packages to the Standard SDK | ||
10 | ============================================== | ||
11 | |||
12 | When you build a standard SDK using the ``bitbake -c populate_sdk``, a | ||
13 | default set of packages is included in the resulting SDK. The | ||
14 | :term:`TOOLCHAIN_HOST_TASK` | ||
15 | and | ||
16 | :term:`TOOLCHAIN_TARGET_TASK` | ||
17 | variables control the set of packages adding to the SDK. | ||
18 | |||
19 | If you want to add individual packages to the toolchain that runs on the | ||
20 | host, simply add those packages to the ``TOOLCHAIN_HOST_TASK`` variable. | ||
21 | Similarly, if you want to add packages to the default set that is part | ||
22 | of the toolchain that runs on the target, add the packages to the | ||
23 | ``TOOLCHAIN_TARGET_TASK`` variable. | ||
24 | |||
25 | Adding API Documentation to the Standard SDK | ||
26 | ============================================ | ||
27 | |||
28 | You can include API documentation as well as any other documentation | ||
29 | provided by recipes with the standard SDK by adding "api-documentation" | ||
30 | to the | ||
31 | :term:`DISTRO_FEATURES` | ||
32 | variable: DISTRO_FEATURES_append = " api-documentation" Setting this | ||
33 | variable as shown here causes the OpenEmbedded build system to build the | ||
34 | documentation and then include it in the standard SDK. | ||