summaryrefslogtreecommitdiff
path: root/poky/documentation/sdk-manual
diff options
context:
space:
mode:
Diffstat (limited to 'poky/documentation/sdk-manual')
-rw-r--r--poky/documentation/sdk-manual/appendix-customizing-standard.rst (renamed from poky/documentation/sdk-manual/sdk-appendix-customizing-standard.rst)0
-rw-r--r--poky/documentation/sdk-manual/appendix-customizing.rst (renamed from poky/documentation/sdk-manual/sdk-appendix-customizing.rst)2
-rw-r--r--poky/documentation/sdk-manual/appendix-obtain.rst (renamed from poky/documentation/sdk-manual/sdk-appendix-obtain.rst)18
-rw-r--r--poky/documentation/sdk-manual/extensible.rst (renamed from poky/documentation/sdk-manual/sdk-extensible.rst)8
-rw-r--r--poky/documentation/sdk-manual/index.rst (renamed from poky/documentation/sdk-manual/sdk-manual.rst)14
-rw-r--r--poky/documentation/sdk-manual/intro.rst (renamed from poky/documentation/sdk-manual/sdk-intro.rst)6
-rw-r--r--poky/documentation/sdk-manual/using.rst (renamed from poky/documentation/sdk-manual/sdk-using.rst)18
-rw-r--r--poky/documentation/sdk-manual/working-projects.rst (renamed from poky/documentation/sdk-manual/sdk-working-projects.rst)12
8 files changed, 39 insertions, 39 deletions
diff --git a/poky/documentation/sdk-manual/sdk-appendix-customizing-standard.rst b/poky/documentation/sdk-manual/appendix-customizing-standard.rst
index 90b634529..90b634529 100644
--- a/poky/documentation/sdk-manual/sdk-appendix-customizing-standard.rst
+++ b/poky/documentation/sdk-manual/appendix-customizing-standard.rst
diff --git a/poky/documentation/sdk-manual/sdk-appendix-customizing.rst b/poky/documentation/sdk-manual/appendix-customizing.rst
index 5a33f6385..97ade0801 100644
--- a/poky/documentation/sdk-manual/sdk-appendix-customizing.rst
+++ b/poky/documentation/sdk-manual/appendix-customizing.rst
@@ -87,7 +87,7 @@ adjustments:
following:
- After ensuring the tasks are :ref:`shared
- state <overview-manual/overview-manual-concepts:shared state cache>` tasks (i.e. the
+ state <overview-manual/concepts:shared state cache>` tasks (i.e. the
output of the task is saved to and can be restored from the shared
state cache) or ensuring the tasks are able to be produced quickly
from a task that is a shared state task, add the task name to the
diff --git a/poky/documentation/sdk-manual/sdk-appendix-obtain.rst b/poky/documentation/sdk-manual/appendix-obtain.rst
index eef425bdf..cdfe2cc85 100644
--- a/poky/documentation/sdk-manual/sdk-appendix-obtain.rst
+++ b/poky/documentation/sdk-manual/appendix-obtain.rst
@@ -15,7 +15,7 @@ and then run the script to hand-install the toolchain.
Follow these steps to locate and hand-install the toolchain:
1. *Go to the Installers Directory:* Go to
- :yocto_dl:`/releases/yocto/yocto-3.1.2/toolchain/`
+ :yocto_dl:`/releases/yocto/yocto-&DISTRO;/toolchain/`
2. *Open the Folder for Your Build Host:* Open the folder that matches
your :term:`Build Host` (i.e.
@@ -81,7 +81,7 @@ As an alternative to locating and downloading an SDK installer, you can
build the SDK installer. Follow these steps:
1. *Set Up the Build Environment:* Be sure you are set up to use BitBake
- in a shell. See the ":ref:`dev-manual/dev-manual-start:preparing the build host`" section
+ in a shell. See the ":ref:`dev-manual/start:preparing the build host`" section
in the Yocto Project Development Tasks Manual for information on how
to get a build host ready that is either a native Linux machine or a
machine that uses CROPS.
@@ -89,9 +89,9 @@ build the SDK installer. Follow these steps:
2. *Clone the ``poky`` Repository:* You need to have a local copy of the
Yocto Project :term:`Source Directory`
(i.e. a local
- ``poky`` repository). See the ":ref:`dev-manual/dev-manual-start:cloning the \`\`poky\`\` repository`" and
- possibly the ":ref:`dev-manual/dev-manual-start:checking out by branch in poky`" and
- ":ref:`checkout-out-by-tag-in-poky`" sections
+ ``poky`` repository). See the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" and
+ possibly the ":ref:`dev-manual/start:checking out by branch in poky`" and
+ ":ref:`dev-manual/start:checking out by tag in poky`" sections
all in the Yocto Project Development Tasks Manual for information on
how to clone the ``poky`` repository and check out the appropriate
branch for your work.
@@ -202,7 +202,7 @@ Follow these steps to extract the root filesystem:
Image File:* You need to find and download the root filesystem image
file that is appropriate for your target system. These files are kept
in machine-specific folders in the
- :yocto_dl:`Index of Releases </releases/yocto/yocto-3.1.2/machines/>`
+ :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`
in the "machines" directory.
The machine-specific folders of the "machines" directory contain
@@ -246,7 +246,7 @@ Follow these steps to extract the root filesystem:
installed the toolchain (e.g. ``poky_sdk``).
Following is an example based on the toolchain installed in the
- ":ref:`sdk-manual/sdk-appendix-obtain:locating pre-built sdk installers`" section:
+ ":ref:`sdk-manual/appendix-obtain:locating pre-built sdk installers`" section:
::
$ source ~/poky_sdk/environment-setup-core2-64-poky-linux
@@ -256,7 +256,7 @@ Follow these steps to extract the root filesystem:
Following is an example command that extracts the root filesystem
from a previously built root filesystem image that was downloaded
- from the :yocto_dl:`Index of Releases </releases/yocto/yocto-3.1.2/machines/>`.
+ from the :yocto_dl:`Index of Releases </releases/yocto/yocto-&DISTRO;/machines/>`.
This command extracts the root filesystem into the ``core2-64-sato``
directory:
::
@@ -285,7 +285,7 @@ Within the figure, italicized text is used to indicate replaceable
portions of the file or directory name. For example, install_dir/version
is the directory where the SDK is installed. By default, this directory
is ``/opt/poky/``. And, version represents the specific snapshot of the
-SDK (e.g. 3.1.2). Furthermore, target represents the target architecture
+SDK (e.g. &DISTRO;). Furthermore, target represents the target architecture
(e.g. ``i586``) and host represents the development system's
architecture (e.g. ``x86_64``). Thus, the complete names of the two
directories within the ``sysroots`` could be ``i586-poky-linux`` and
diff --git a/poky/documentation/sdk-manual/sdk-extensible.rst b/poky/documentation/sdk-manual/extensible.rst
index 10e4d2061..c94213d6c 100644
--- a/poky/documentation/sdk-manual/sdk-extensible.rst
+++ b/poky/documentation/sdk-manual/extensible.rst
@@ -47,7 +47,7 @@ Host` by running the ``*.sh`` installation script.
You can download a tarball installer, which includes the pre-built
toolchain, the ``runqemu`` script, the internal build system,
``devtool``, and support files from the appropriate
-:yocto_dl:`toolchain </releases/yocto/yocto-3.1.2/toolchain/>` directory within the Index of
+:yocto_dl:`toolchain </releases/yocto/yocto-&DISTRO;/toolchain/>` directory within the Index of
Releases. Toolchains are available for several 32-bit and 64-bit
architectures with the ``x86_64`` directories, respectively. The
toolchains the Yocto Project provides are based off the
@@ -78,7 +78,7 @@ is the general form:
release_version is a string representing the release number of the Yocto Project:
- 3.1.2, 3.1.2+snapshot
+ &DISTRO;, &DISTRO;+snapshot
For example, the following SDK installer is for a 64-bit
development host system and a i586-tuned target architecture based off
@@ -183,7 +183,7 @@ system.
part of an image built using the build system.
The ``devtool`` command line is organized similarly to
-:ref:`overview-manual/overview-manual-development-environment:git` in that it has a number of
+:ref:`overview-manual/development-environment:git` in that it has a number of
sub-commands for each function. You can run ``devtool --help`` to see
all the commands.
@@ -627,7 +627,7 @@ specify source code revision and versioning schemes, extract code into
or out of the ``devtool``
:ref:`devtool-the-workspace-layer-structure`,
and work with any source file forms that the
-:ref:`fetchers <bitbake:bb-fetchers>` support.
+:ref:`fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` support.
The following diagram shows the common development flow used with the
``devtool upgrade`` command:
diff --git a/poky/documentation/sdk-manual/sdk-manual.rst b/poky/documentation/sdk-manual/index.rst
index 177826edf..fce2b199c 100644
--- a/poky/documentation/sdk-manual/sdk-manual.rst
+++ b/poky/documentation/sdk-manual/index.rst
@@ -10,13 +10,13 @@ Yocto Project Application Development and the Extensible Software Development Ki
:caption: Table of Contents
:numbered:
- sdk-intro
- sdk-extensible
- sdk-using
- sdk-working-projects
- sdk-appendix-obtain
- sdk-appendix-customizing
- sdk-appendix-customizing-standard
+ intro
+ extensible
+ using
+ working-projects
+ appendix-obtain
+ appendix-customizing
+ appendix-customizing-standard
history
.. include:: /boilerplate.rst
diff --git a/poky/documentation/sdk-manual/sdk-intro.rst b/poky/documentation/sdk-manual/intro.rst
index ca6138cce..66b12cdff 100644
--- a/poky/documentation/sdk-manual/sdk-intro.rst
+++ b/poky/documentation/sdk-manual/intro.rst
@@ -184,7 +184,7 @@ You just need to follow these general steps:
root filesystem images.
If you are going to develop your application on hardware, go to the
- :yocto_dl:`machines </releases/yocto/yocto-3.1.2/machines/>` download area and choose a
+ :yocto_dl:`machines </releases/yocto/yocto-&DISTRO;/machines/>` download area and choose a
target machine area from which to download the kernel image and root
filesystem. This download area could have several files in it that
support development using actual hardware. For example, the area
@@ -194,7 +194,7 @@ You just need to follow these general steps:
If you are going to develop your application and then run and test it
using the QEMU emulator, go to the
- :yocto_dl:`machines/qemu </releases/yocto/yocto-3.1.2/machines/qemu>` download area. From this
+ :yocto_dl:`machines/qemu </releases/yocto/yocto-&DISTRO;/machines/qemu>` download area. From this
area, go down into the directory for your target architecture (e.g.
``qemux86_64`` for an Intel-based 64-bit architecture). Download the
kernel, root filesystem, and any other files you need for your
@@ -211,7 +211,7 @@ You just need to follow these general steps:
tools to develop your application. If you need to separately install
and use the QEMU emulator, you can go to `QEMU Home
Page <http://wiki.qemu.org/Main_Page>`__ to download and learn about
- the emulator. See the ":doc:`../dev-manual/dev-manual-qemu`" chapter in the
+ the emulator. See the ":doc:`/dev-manual/qemu`" chapter in the
Yocto Project Development Tasks Manual for information on using QEMU
within the Yocto Project.
diff --git a/poky/documentation/sdk-manual/sdk-using.rst b/poky/documentation/sdk-manual/using.rst
index 3a1cae773..29fb50465 100644
--- a/poky/documentation/sdk-manual/sdk-using.rst
+++ b/poky/documentation/sdk-manual/using.rst
@@ -43,7 +43,7 @@ Host` by running the ``*.sh`` installation script.
You can download a tarball installer, which includes the pre-built
toolchain, the ``runqemu`` script, and support files from the
-appropriate :yocto_dl:`toolchain </releases/yocto/yocto-3.1.2/toolchain/>` directory within
+appropriate :yocto_dl:`toolchain </releases/yocto/yocto-&DISTRO;/toolchain/>` directory within
the Index of Releases. Toolchains are available for several 32-bit and
64-bit architectures with the ``x86_64`` directories, respectively. The
toolchains the Yocto Project provides are based off the
@@ -72,7 +72,7 @@ immediately followed by a string representing the target architecture.
release_version is a string representing the release number of the Yocto Project:
- 3.1.2, 3.1.2+snapshot
+ &DISTRO;, &DISTRO;+snapshot
For example, the following SDK installer is for a 64-bit
development host system and a i586-tuned target architecture based off
@@ -109,16 +109,16 @@ architecture. The example assumes the SDK installer is located in
::
- $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-3.1.2.sh
- Poky (Yocto Project Reference Distro) SDK installer version 3.1.2
+ $ ./Downloads/poky-glibc-x86_64-core-image-sato-i586-toolchain-&DISTRO;.sh
+ Poky (Yocto Project Reference Distro) SDK installer version &DISTRO;
===============================================================
- Enter target directory for SDK (default: /opt/poky/3.1.2):
- You are about to install the SDK to "/opt/poky/3.1.2". Proceed [Y/n]? Y
+ Enter target directory for SDK (default: /opt/poky/&DISTRO;):
+ You are about to install the SDK to "/opt/poky/&DISTRO;". Proceed [Y/n]? Y
Extracting SDK........................................ ..............................done
Setting it up...done
SDK has been successfully set up and is ready to be used.
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/3.1.2/environment-setup-i586-poky-linux
+ $ . /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
Again, reference the "`Installed Standard SDK Directory
Structure <#sdk-installed-standard-sdk-directory-structure>`__" section
@@ -131,7 +131,7 @@ Running the SDK Environment Setup Script
Once you have the SDK installed, you must run the SDK environment setup
script before you can actually use the SDK. This setup script resides in
the directory you chose when you installed the SDK, which is either the
-default ``/opt/poky/3.1.2`` directory or the directory you chose during
+default ``/opt/poky/&DISTRO;`` directory or the directory you chose during
installation.
Before running the script, be sure it is the one that matches the
@@ -143,7 +143,7 @@ then source the environment setup script. In this example, the setup
script is for an IA-based target machine using i586 tuning:
::
- $ source /opt/poky/3.1.2/environment-setup-i586-poky-linux
+ $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
When you run the
setup script, the same environment variables are defined as are when you
diff --git a/poky/documentation/sdk-manual/sdk-working-projects.rst b/poky/documentation/sdk-manual/working-projects.rst
index 5c828fd58..3e40936ff 100644
--- a/poky/documentation/sdk-manual/sdk-working-projects.rst
+++ b/poky/documentation/sdk-manual/working-projects.rst
@@ -10,7 +10,7 @@ projects.
Autotools-Based Projects
========================
-Once you have a suitable :ref:`sdk-manual/sdk-intro:the cross-development toolchain`
+Once you have a suitable :ref:`sdk-manual/intro:the cross-development toolchain`
installed, it is very easy to develop a project using the `GNU
Autotools-based <https://en.wikipedia.org/wiki/GNU_Build_System>`__
workflow, which is outside of the :term:`OpenEmbedded Build System`.
@@ -86,11 +86,11 @@ project:
the string "environment-setup" and contains the machine architecture,
which is followed by the string "poky-linux". For this example, the
command sources a script from the default SDK installation directory
- that uses the 32-bit Intel x86 Architecture and the 3.1.2 Yocto
+ that uses the 32-bit Intel x86 Architecture and the &DISTRO; Yocto
Project release:
::
- $ source /opt/poky/3.1.2/environment-setup-i586-poky-linux
+ $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
3. *Create the configure Script:* Use the ``autoreconf`` command to
generate the ``configure`` script.
@@ -229,14 +229,14 @@ a null value for the compiler variable (i.e.
Running the
SDK setup script for a 64-bit build host and an i586-tuned target
-architecture for a ``core-image-sato`` image using the current 3.1.2
+architecture for a ``core-image-sato`` image using the current &DISTRO;
Yocto Project release and then echoing that variable shows the value
established through the script:
::
- $ source /opt/poky/3.1.2/environment-setup-i586-poky-linux
+ $ source /opt/poky/&DISTRO;/environment-setup-i586-poky-linux
$ echo ${CC}
- i586-poky-linux-gcc -m32 -march=i586 --sysroot=/opt/poky/3.1.2/sysroots/i586-poky-linux
+ i586-poky-linux-gcc -m32 -march=i586 --sysroot=/opt/poky/&DISTRO;/sysroots/i586-poky-linux
To illustrate variable use, work through this simple "Hello World!"
example: