summaryrefslogtreecommitdiff
path: root/poky/documentation/sdk-manual
diff options
context:
space:
mode:
authorAndrew Geissler <geissonator@yahoo.com>2021-04-15 23:55:55 +0300
committerBrad Bishop <bradleyb@fuzziesquirrel.com>2021-04-19 16:32:18 +0300
commit3b8a17c1d70bac29dd3f1fb727716b7c2151b64a (patch)
treecc03ed84987f273db964a019f862b08a131d67fa /poky/documentation/sdk-manual
parente34f89623c246d261efb7fd0f2ce4a30b10bd59d (diff)
downloadopenbmc-3b8a17c1d70bac29dd3f1fb727716b7c2151b64a.tar.xz
poky: subtree update:7d0988966c..1203d1f24d
Alexander Kanavin (5): mesa: update 21.0.0 -> 21.0.1 runqemu: do not stop processing graphical options after nographic mesa: gallium option requires libdrm mesa: enable dri in native/nativesdk through gallium drivers ptest-runner: correct version check Alistair Francis (2): conf/machine: Enable bochs-display on RISC-V machines conf/machine: Enable keyboard and mouse on RISC-V machines Anibal Limon (1): ptest-runner: Upgrade to 2.4.1 Awais Belal (2): perl: allow empty lines and comments in perl-rdepends.txt perl: fix creation and generate new perl-rdepends.txt Bruce Ashfield (1): perf-tests: add bash into RDEPENDS (v5.12-rc5+) Chen Qi (1): apt: Fix do_compile error when enable ccache Denys Dmytriyenko (1): make-mod-scripts: pass CROSS_COMPILE to configure and build Guillaume Champagne (1): image-live.bbclass: optional depends when ROOTFS empty Janne Kiiskila (1): poky.yaml: Use git instead of git-core for Ubunti Joshua Watt (1): bitbake.conf: Limit the number of OpenMP threads Khem Raj (3): mesa-gl: Use swrast gallium driver binutils: Fix a missing break in case statement webkitgtk: Drop include_array.patch Klaus Heinrich Kiwi (6): uboot: Deploy default symlinks with fitImage u-boot: Move definitions to common locations u-boot: Add infrastructure to SPL verified boot u-boot: Use a different Key for SPL signing oe-selftest: Add U-Boot fitImage signing testcases uboot: Fixes SPL verified boot on corner cases Matt Madison (1): libxcb: use PN for naming dynamic packages Michael Halstead (1): releases: update to include 3.2.3 Michael Opdenacker (7): manuals: Spellcheck and capitalization fixes SDK manual: fix reference to appendix Quick build: checkout a branch instead of a fixed tag manuals: Fix typos and spacing overview-manual: style improvements ref-manual: fix typo manuals: fix suspicious newlines Nicolas Dechesne (1): docs: add a top level page for bitbake documentation Paul Eggleton (16): bitbake: bitbake-user-manual: document no support for using passwords in git URLs bitbake: bitbake-user-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry ref-manual: add METADATA_REVISION and METADATA_BRANCH Use variables for minimum host versions and bump Python to 3.6 ref-manual: update/fix text for SDK_VERSION overview-manual: fix git command line ref-manual: and SDK_CUSTOM_TEMPLATECONF to glossary ref-manual: add REQUIRED_VERSION and adjust PREFERRED_VERSION entry ref-manual: add python3targetconfig class and remove python 2 references ref-manual: add passwd-expire to EXTRA_USERS_PARAMS ref-manual: add FIT_KERNEL_COMP_ALG* ref-manual: fix reference to build-essential ref-manual: tweak buildtools section ref-manual: add migration section for 3.3 release ref-manual: migration guide: add release codenames ref-manual: add mention of DISTUTILS_SETUP_PATH Quentin Schulz (1): docs: replace anchor links Richard Purdie (9): oeqa/concurrencytest: Rename variables to improve the code oeqa/concurrencytest: Fix display of test stdout/stderr diffoscope: Upgrade 168 -> 172 oeqa/runqemu: Support RUNQEMU_TMPFS_DIR as a location to copy snapshot images to bitbake: runqueue: Further fixes for confused setscene tasks documentation/poky.yaml: Fix latest 3.2 series tag reference poky.conf: Bump version for 3.3 hardknott release build-appliance-image: Update to master head revision bitbake: bitbake: Update version to 1.50.0 stable release series Ross Burton (2): poky.yaml: change gcc-multilib to gcc oeqa/selftest: add test case for SRC_URI dependency sniffing Ulrich Ölmann (1): sdk-manual: fix typo Yann Dirson (1): kernel-yocto: fix do_kernel_configme indentation Yi Fan Yu (2): python3: Skip failing ptests due to load variability valgrind: print failed ptest details Signed-off-by: Andrew Geissler <geissonator@yahoo.com> Change-Id: Id57d0682ec91b67b90fac931313457f5ed6f3d5c
Diffstat (limited to 'poky/documentation/sdk-manual')
-rw-r--r--poky/documentation/sdk-manual/appendix-customizing.rst27
-rw-r--r--poky/documentation/sdk-manual/appendix-obtain.rst18
-rw-r--r--poky/documentation/sdk-manual/extensible.rst19
-rw-r--r--poky/documentation/sdk-manual/intro.rst4
-rw-r--r--poky/documentation/sdk-manual/using.rst22
-rw-r--r--poky/documentation/sdk-manual/working-projects.rst9
6 files changed, 45 insertions, 54 deletions
diff --git a/poky/documentation/sdk-manual/appendix-customizing.rst b/poky/documentation/sdk-manual/appendix-customizing.rst
index 97ade0801..8e7115046 100644
--- a/poky/documentation/sdk-manual/appendix-customizing.rst
+++ b/poky/documentation/sdk-manual/appendix-customizing.rst
@@ -101,17 +101,15 @@ adjustments:
- Generally, you want to have a shared state mirror set up so users of
the SDK can add additional items to the SDK after installation
- without needing to build the items from source. See the "`Providing
- Additional Installable Extensible SDK
- Content <#sdk-providing-additional-installable-extensible-sdk-content>`__"
+ without needing to build the items from source. See the
+ ":ref:`sdk-manual/appendix-customizing:providing additional installable extensible sdk content`"
section for information.
- If you want users of the SDK to be able to easily update the SDK, you
need to set the
:term:`SDK_UPDATE_URL`
- variable. For more information, see the "`Providing Updates to the
- Extensible SDK After
- Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__"
+ variable. For more information, see the
+ ":ref:`sdk-manual/appendix-customizing:providing updates to the extensible sdk after installation`"
section.
- If you have adjusted the list of files and directories that appear in
@@ -139,9 +137,9 @@ Changing the Extensible SDK Installer Title
You can change the displayed title for the SDK installer by setting the
:term:`SDK_TITLE` variable and then
-rebuilding the the SDK installer. For information on how to build an SDK
-installer, see the "`Building an SDK
-Installer <#sdk-building-an-sdk-installer>`__" section.
+rebuilding the SDK installer. For information on how to build an SDK
+installer, see the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
+section.
By default, this title is derived from
:term:`DISTRO_NAME` when it is
@@ -189,9 +187,8 @@ the installed SDKs to update the installed SDKs by using the
variable to point to the corresponding HTTP or HTTPS URL. Setting
this variable causes any SDK built to default to that URL and thus,
the user does not have to pass the URL to the ``devtool sdk-update``
- command as described in the "`Applying Updates to an Installed
- Extensible
- SDK <#sdk-applying-updates-to-an-installed-extensible-sdk>`__"
+ command as described in the
+ ":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`"
section.
3. Build the extensible SDK normally (i.e., use the
@@ -208,9 +205,9 @@ the installed SDKs to update the installed SDKs by using the
Completing the above steps allows users of the existing installed SDKs
to simply run ``devtool sdk-update`` to retrieve and apply the latest
-updates. See the "`Applying Updates to an Installed Extensible
-SDK <#sdk-applying-updates-to-an-installed-extensible-sdk>`__" section
-for further information.
+updates. See the
+":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`"
+section for further information.
Changing the Default SDK Installation Directory
===============================================
diff --git a/poky/documentation/sdk-manual/appendix-obtain.rst b/poky/documentation/sdk-manual/appendix-obtain.rst
index 395102c3b..3c1dc52d1 100644
--- a/poky/documentation/sdk-manual/appendix-obtain.rst
+++ b/poky/documentation/sdk-manual/appendix-obtain.rst
@@ -38,7 +38,7 @@ Follow these steps to locate and hand-install the toolchain:
"sato" or "minimal"
arch is a string representing the target architecture:
- "aarch64", "armv5e", "core2-64", "coretexa8hf-neon", "i586", "mips32r2",
+ "aarch64", "armv5e", "core2-64", "cortexa8hf-neon", "i586", "mips32r2",
"mips64", or "ppc7400"
release is the version of Yocto Project.
@@ -68,10 +68,10 @@ Follow these steps to locate and hand-install the toolchain:
$ ~/Downloads/poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
During execution of the script, you choose the root location for the
- toolchain. See the "`Installed Standard SDK Directory
- Structure <#sdk-installed-standard-sdk-directory-structure>`__"
- section and the "`Installed Extensible SDK Directory
- Structure <#sdk-installed-extensible-sdk-directory-structure>`__"
+ toolchain. See the
+ ":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
+ section and the
+ ":ref:`sdk-manual/appendix-obtain:installed extensible sdk directory structure`"
section for more information.
Building an SDK Installer
@@ -177,10 +177,10 @@ build the SDK installer. Follow these steps:
$ ./poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh
During execution of the script, you choose the root location for the
- toolchain. See the "`Installed Standard SDK Directory
- Structure <#sdk-installed-standard-sdk-directory-structure>`__"
- section and the "`Installed Extensible SDK Directory
- Structure <#sdk-installed-extensible-sdk-directory-structure>`__"
+ toolchain. See the
+ ":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
+ section and the
+ ":ref:`sdk-manual/appendix-obtain:installed extensible sdk directory structure`"
section for more information.
Extracting the Root Filesystem
diff --git a/poky/documentation/sdk-manual/extensible.rst b/poky/documentation/sdk-manual/extensible.rst
index d2ed9a9b8..baa432ef3 100644
--- a/poky/documentation/sdk-manual/extensible.rst
+++ b/poky/documentation/sdk-manual/extensible.rst
@@ -21,8 +21,9 @@ hardware, and ease integration into the rest of the
In addition to the functionality available through ``devtool``, you can
alternatively make use of the toolchain directly, for example from
-Makefile and Autotools. See the "`Using the SDK Toolchain
-Directly <#sdk-working-projects>`__" chapter for more information.
+Makefile and Autotools. See the
+":ref:`sdk-manual/working-projects:using the sdk toolchain directly`" chapter
+for more information.
Why use the Extensible SDK and What is in It?
=============================================
@@ -1087,12 +1088,12 @@ links created within the source tree:
- ``sysroot-destdir/``: Contains a subset of files installed within
``do_install`` that have been put into the shared sysroot. For
- more information, see the "`Sharing Files Between
- Recipes <#sdk-sharing-files-between-recipes>`__" section.
+ more information, see the
+ ":ref:`dev-manual/common-tasks:sharing files between recipes`" section.
- ``packages-split/``: Contains subdirectories for each package
produced by the recipe. For more information, see the
- "`Packaging <#sdk-packaging>`__" section.
+ ":ref:`sdk-manual/extensible:packaging`" section.
You can use these links to get more information on what is happening at
each build step.
@@ -1271,11 +1272,9 @@ To update your installed SDK, use ``devtool`` as follows:
$ devtool sdk-update
The previous command assumes your SDK provider has set the
-default update URL for you through the
-:term:`SDK_UPDATE_URL`
-variable as described in the "`Providing Updates to the Extensible SDK
-After
-Installation <#sdk-providing-updates-to-the-extensible-sdk-after-installation>`__"
+default update URL for you through the :term:`SDK_UPDATE_URL`
+variable as described in the
+":ref:`sdk-manual/appendix-customizing:Providing Updates to the Extensible SDK After Installation`"
section. If the SDK provider has not set that default URL, you need to
specify it yourself in the command as follows: $ devtool sdk-update
path_to_update_directory
diff --git a/poky/documentation/sdk-manual/intro.rst b/poky/documentation/sdk-manual/intro.rst
index e4b9b05ba..d966efea7 100644
--- a/poky/documentation/sdk-manual/intro.rst
+++ b/poky/documentation/sdk-manual/intro.rst
@@ -176,8 +176,8 @@ image.
You just need to follow these general steps:
1. *Install the SDK for your target hardware:* For information on how to
- install the SDK, see the "`Installing the
- SDK <#sdk-installing-the-sdk>`__" section.
+ install the SDK, see the ":ref:`sdk-manual/using:installing the sdk`"
+ section.
2. *Download or Build the Target Image:* The Yocto Project supports
several target architectures and has many pre-built kernel images and
diff --git a/poky/documentation/sdk-manual/using.rst b/poky/documentation/sdk-manual/using.rst
index 29fb50465..62967f557 100644
--- a/poky/documentation/sdk-manual/using.rst
+++ b/poky/documentation/sdk-manual/using.rst
@@ -16,8 +16,9 @@ standard SDK.
" section.
You can use a standard SDK to work on Makefile and Autotools-based
-projects. See the "`Using the SDK Toolchain
-Directly <#sdk-working-projects>`__" chapter for more information.
+projects. See the
+":ref:`sdk-manual/working-projects:using the sdk toolchain directly`" chapter
+for more information.
Why use the Standard SDK and What is in It?
===========================================
@@ -31,9 +32,9 @@ the extensible SDK, which provides an internal build system and the
The installed Standard SDK consists of several files and directories.
Basically, it contains an SDK environment setup script, some
configuration files, and host and target root filesystems to support
-usage. You can see the directory structure in the "`Installed Standard
-SDK Directory
-Structure <#sdk-installed-standard-sdk-directory-structure>`__" section.
+usage. You can see the directory structure in the
+":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
+section.
Installing the SDK
==================
@@ -120,9 +121,9 @@ architecture. The example assumes the SDK installer is located in
Each time you wish to use the SDK in a new shell session, you need to source the environment setup script e.g.
$ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
-Again, reference the "`Installed Standard SDK Directory
-Structure <#sdk-installed-standard-sdk-directory-structure>`__" section
-for more details on the resulting directory structure of the installed
+Again, reference the
+":ref:`sdk-manual/appendix-obtain:installed standard sdk directory structure`"
+section for more details on the resulting directory structure of the installed
SDK.
Running the SDK Environment Setup Script
@@ -147,7 +148,6 @@ script is for an IA-based target machine using i586 tuning:
When you run the
setup script, the same environment variables are defined as are when you
-run the setup script for an extensible SDK. See the "`Running the
-Extensible SDK Environment Setup
-Script <#sdk-running-the-extensible-sdk-environment-setup-script>`__"
+run the setup script for an extensible SDK. See the
+":ref:`sdk-manual/appendix-obtain:installed extensible sdk directory structure`"
section for more information.
diff --git a/poky/documentation/sdk-manual/working-projects.rst b/poky/documentation/sdk-manual/working-projects.rst
index bddf00a7d..f880cbe0d 100644
--- a/poky/documentation/sdk-manual/working-projects.rst
+++ b/poky/documentation/sdk-manual/working-projects.rst
@@ -104,10 +104,7 @@ project:
.. note::
- If you get errors from
- configure.ac
- , which
- autoreconf
+ If you get errors from ``configure.ac``, which ``autoreconf``
runs, that indicate missing files, you can use the "-i" option,
which ensures missing auxiliary files are copied to the build
host.
@@ -206,9 +203,7 @@ regarding variable behavior:
.. note::
Regardless of how you set your variables, if you use the "-e" option
- with
- make
- , the variables from the SDK setup script take precedence:
+ with ``make``, the variables from the SDK setup script take precedence:
::
$ make -e target