From 912a3c52e26e4bae8222138f291a86c61838506e Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Wed, 25 Nov 2020 09:33:33 +0100 Subject: {dev,kernel,sdk}-manual: replace hardcoded release version with &DISTRO; In the Docbook files we had DISTRO, but somehow it was lost during the migration to Sphinx. (From yocto-docs rev: d10bb13070039e17281fccc5c1a64b5bfed30543) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-qemu.rst | 2 +- documentation/kernel-dev/kernel-dev-common.rst | 4 ++-- documentation/sdk-manual/sdk-appendix-obtain.rst | 8 ++++---- documentation/sdk-manual/sdk-extensible.rst | 4 ++-- documentation/sdk-manual/sdk-intro.rst | 4 ++-- documentation/sdk-manual/sdk-using.rst | 18 +++++++++--------- documentation/sdk-manual/sdk-working-projects.rst | 10 +++++----- 7 files changed, 25 insertions(+), 25 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-qemu.rst b/documentation/dev-manual/dev-manual-qemu.rst index c91e8b5389..63640411d4 100644 --- a/documentation/dev-manual/dev-manual-qemu.rst +++ b/documentation/dev-manual/dev-manual-qemu.rst @@ -81,7 +81,7 @@ available. Follow these general steps to run QEMU: your :term:`Build Directory`. - If you have not built an image, you can go to the - :yocto_dl:`machines/qemu ` area and download a + :yocto_dl:`machines/qemu ` area and download a pre-built image that matches your architecture and can be run on QEMU. diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst index 72d9d78796..e548fa3a9d 100644 --- a/documentation/kernel-dev/kernel-dev-common.rst +++ b/documentation/kernel-dev/kernel-dev-common.rst @@ -147,8 +147,8 @@ section: :: $ cd ~/poky/build/tmp/deploy/sdk - $ ./poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-3.1.2.sh - Poky (Yocto Project Reference Distro) Extensible SDK installer version 3.1.2 + $ ./poky-glibc-x86_64-core-image-minimal-i586-toolchain-ext-&DISTRO;.sh + Poky (Yocto Project Reference Distro) Extensible SDK installer version &DISTRO; ============================================================================ Enter target directory for SDK (default: ~/poky_sdk): You are about to install the SDK to "/home/scottrif/poky_sdk". Proceed [Y/n]? Y diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst index eef425bdf0..1a2e4c387b 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.rst +++ b/documentation/sdk-manual/sdk-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. @@ -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 ` + :yocto_dl:`Index of Releases ` in the "machines" directory. The machine-specific folders of the "machines" directory contain @@ -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 `. + from the :yocto_dl:`Index of Releases `. 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/documentation/sdk-manual/sdk-extensible.rst b/documentation/sdk-manual/sdk-extensible.rst index 10e4d20611..1a17da4f6e 100644 --- a/documentation/sdk-manual/sdk-extensible.rst +++ b/documentation/sdk-manual/sdk-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 ` directory within the Index of +:yocto_dl:`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 diff --git a/documentation/sdk-manual/sdk-intro.rst b/documentation/sdk-manual/sdk-intro.rst index ca6138cce3..bbd33b8a78 100644 --- a/documentation/sdk-manual/sdk-intro.rst +++ b/documentation/sdk-manual/sdk-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 ` download area and choose a + :yocto_dl:`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 ` download area. From this + :yocto_dl:`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 diff --git a/documentation/sdk-manual/sdk-using.rst b/documentation/sdk-manual/sdk-using.rst index 3a1cae773f..29fb50465f 100644 --- a/documentation/sdk-manual/sdk-using.rst +++ b/documentation/sdk-manual/sdk-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 ` directory within +appropriate :yocto_dl:`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/documentation/sdk-manual/sdk-working-projects.rst b/documentation/sdk-manual/sdk-working-projects.rst index 5c828fd586..4f97640327 100644 --- a/documentation/sdk-manual/sdk-working-projects.rst +++ b/documentation/sdk-manual/sdk-working-projects.rst @@ -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: -- cgit v1.2.3-54-g00ecf