mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02:00
7d3f57cfd2
If a variable has a glossary entry and some rST files write about those
variables, it's better to point to the glossary entry instead of just
highlighting it by surrounding it with two tick quotes.
This was automated by the following python script:
"""
import re
from pathlib import Path
with open('objects.inv.txt', 'r') as f:
objects = f.readlines()
with open('bitbake-objects.inv.txt', 'r') as f:
objects = objects + f.readlines()
re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)')
terms = []
for obj in objects:
match = re_term.search(obj)
if match and match.group(1):
terms.append(match.group(1))
for rst in Path('.').rglob('*.rst'):
with open(rst, 'r') as f:
content = "".joing(f.readlines())
for term in terms:
content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content)
with open(rst, 'w') as f:
f.write(content)
"""
(From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
35 lines
1.3 KiB
ReStructuredText
35 lines
1.3 KiB
ReStructuredText
.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
|
|
|
|
****************************
|
|
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
|
|
:term:`TOOLCHAIN_HOST_TASK`
|
|
and
|
|
:term:`TOOLCHAIN_TARGET_TASK`
|
|
variables control 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 :term:`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
|
|
:term:`TOOLCHAIN_TARGET_TASK` variable.
|
|
|
|
Adding API Documentation to the Standard SDK
|
|
============================================
|
|
|
|
You can include API documentation as well as any other documentation
|
|
provided by recipes with the standard SDK by adding "api-documentation"
|
|
to the
|
|
:term:`DISTRO_FEATURES`
|
|
variable: DISTRO_FEATURES_append = " api-documentation" Setting this
|
|
variable as shown here causes the OpenEmbedded build system to build the
|
|
documentation and then include it in the standard SDK.
|