From 424567d629b08785a6594d16427ee0fa8c31f384 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Mon, 27 Jul 2020 17:38:09 +0200 Subject: sphinx: manual updates for some links Some links were not found by the regexp, especially because of they are spanning across multiple lines. This patch is a manual fixup for these patterns. (From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/adt-manual/adt-command.rst | 4 ++-- documentation/adt-manual/adt-intro.rst | 14 +++++++------- documentation/adt-manual/adt-package.rst | 2 +- documentation/adt-manual/adt-prepare.rst | 29 +++++++++++++---------------- 4 files changed, 23 insertions(+), 26 deletions(-) (limited to 'documentation/adt-manual') diff --git a/documentation/adt-manual/adt-command.rst b/documentation/adt-manual/adt-command.rst index 8b86544f19..de854772bb 100644 --- a/documentation/adt-manual/adt-command.rst +++ b/documentation/adt-manual/adt-command.rst @@ -6,8 +6,8 @@ Using the Command Line Recall that earlier the manual discussed how to use an existing toolchain tarball that had been installed into the default installation -directory, ``/opt/poky/DISTRO``, which is outside of the `Build -Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__ (see the section +directory, ``/opt/poky/DISTRO``, which is outside of the :term:`Build Directory` +(see the section "`Using a Cross-Toolchain Tarball) <#using-an-existing-toolchain-tarball>`__". And, that sourcing your architecture-specific environment setup script initializes a diff --git a/documentation/adt-manual/adt-intro.rst b/documentation/adt-manual/adt-intro.rst index 40612bdddf..d6228ad864 100644 --- a/documentation/adt-manual/adt-intro.rst +++ b/documentation/adt-manual/adt-intro.rst @@ -12,8 +12,8 @@ application. Fundamentally, the ADT consists of the following: - An architecture-specific cross-toolchain and matching sysroot both - built by the `OpenEmbedded build - system <&YOCTO_DOCS_DEV_URL;#build-system-term>`__. The toolchain and + built by the :term:`OpenEmbedded Build System`. + The toolchain and sysroot are based on a `Metadata <&YOCTO_DOCS_DEV_URL;#metadata>`__ configuration and extensions, which allows you to cross-develop on the host machine for the target hardware. @@ -33,8 +33,8 @@ Toolchain <&YOCTO_DOCS_DEV_URL;#cross-development-toolchain>`__ consists of a cross-compiler, cross-linker, and cross-debugger that are used to develop user-space applications for targeted hardware. This toolchain is created either by running the ADT Installer script, a toolchain -installer script, or through a `Build -Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__ that is based on +installer script, or through a :term:`Build Directory` +that is based on your Metadata configuration or extension for your targeted device. The cross-toolchain works with a matching target sysroot. @@ -79,13 +79,13 @@ your application or image. QEMU is made available a number of ways: - If you use the ADT Installer script to install ADT, you can specify whether or not to install QEMU. -- If you have cloned the ``poky`` Git repository to create a `Source - Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__ and you have +- If you have cloned the ``poky`` Git repository to create a + :term:`Source Directory` and you have sourced the environment setup script, QEMU is installed and automatically available. - If you have downloaded a Yocto Project release and unpacked it to - create a `Source Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__ + create a :term:`Source Directory` and you have sourced the environment setup script, QEMU is installed and automatically available. diff --git a/documentation/adt-manual/adt-package.rst b/documentation/adt-manual/adt-package.rst index 38823a104f..dfa62163b3 100644 --- a/documentation/adt-manual/adt-package.rst +++ b/documentation/adt-manual/adt-package.rst @@ -59,7 +59,7 @@ add it into a working ``opkg`` repository. Use these commands: $ bitbake libglade $ bitbake package-index Next, source the cross-toolchain environment setup script found in the -`Source Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__. Follow +:term:`Source Directory`. Follow that by setting up the installation destination to point to your sysroot as sysroot_dir. Finally, have an OPKG configuration file conf_file that corresponds to the ``opkg`` repository you have just created. The diff --git a/documentation/adt-manual/adt-prepare.rst b/documentation/adt-manual/adt-prepare.rst index 12b1e7918c..27133d21b4 100644 --- a/documentation/adt-manual/adt-prepare.rst +++ b/documentation/adt-manual/adt-prepare.rst @@ -50,7 +50,7 @@ for more information. other mentioned benefits had you run the ADT Installer script. - *Use the toolchain from within the Build Directory:* If you already - have a `Build Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__, + have a :term:`Build Directory`, you can build the cross-toolchain within the directory. However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you do not get any of the other benefits without taking @@ -79,9 +79,8 @@ the tarball using either of these methods: ` <&YOCTO_ADTINSTALLER_DL_URL;>`__ into any directory. - *Build the Tarball:* You can use - `BitBake <&YOCTO_DOCS_DEV_URL;#bitbake-term>`__ to generate the - tarball inside an existing `Build - Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__. + :term:`BitBake` to generate the + tarball inside an existing :term:`Build Directory`. If you use BitBake to generate the ADT Installer tarball, you must ``source`` the environment setup script @@ -90,8 +89,8 @@ the tarball using either of these methods: located in the Source Directory before running the ``bitbake`` command that creates the tarball. - The following example commands establish the `Source - Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__, check out the + The following example commands establish the + :term:`Source Directory`, check out the current release branch, set up the build environment while also creating the default Build Directory, and run the ``bitbake`` command that results in the tarball @@ -268,8 +267,8 @@ Using BitBake and the Build Directory ------------------------------------- A final way of making the cross-toolchain available is to use BitBake to -generate the toolchain within an existing `Build -Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__. This method does +generate the toolchain within an existing :term:`Build Directory`. +This method does not install the toolchain into the default ``/opt`` directory. As with the previous method, if you need to install the target sysroot, you must do that separately as well. @@ -280,8 +279,7 @@ Follow these steps to generate the toolchain into the Build Directory: environment setup script (i.e. ````` <&YOCTO_DOCS_REF_URL;#structure-core-script>`__ or ```oe-init-build-env-memres`` <&YOCTO_DOCS_REF_URL;#structure-memres-core-script>`__) - located in the `Source - Directory <&YOCTO_DOCS_DEV_URL;#source-directory>`__. + located in the :term:`Source Directory`. 2. *Check your Local Configuration File:* At this point, you should be sure that the :term:`MACHINE` @@ -332,8 +330,8 @@ cross-development environment by sourcing the toolchain's environment setup script. If you used the ADT Installer or hand-installed cross-toolchain, then you can find this script in the directory you chose for installation. For this release, the default installation -directory is ````. If you installed the toolchain in the `Build -Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__, you can find the +directory is ````. If you installed the toolchain in the +:term:`Build Directory`, you can find the environment setup script for the toolchain in the Build Directory's ``tmp`` directory. @@ -432,8 +430,8 @@ this by including the ``eclipse-debug`` image feature. image features. To include the ``eclipse-debug`` image feature, modify your -``local.conf`` file in the `Build -Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__ so that the +``local.conf`` file in the :term:`Build Directory` +so that the :term:`EXTRA_IMAGE_FEATURES` variable includes the "eclipse-debug" feature. After modifying the configuration file, you can rebuild the image. Once the image is @@ -484,8 +482,7 @@ Optionally Building a Toolchain Installer ========================================= As an alternative to locating and downloading a toolchain installer, you -can build the toolchain installer if you have a `Build -Directory <&YOCTO_DOCS_DEV_URL;#build-directory>`__. +can build the toolchain installer if you have a :term:`Build Directory`. .. note:: -- cgit v1.2.3-54-g00ecf