summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2020-09-17 23:09:47 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-22 09:58:50 +0100
commitd6ce950527981cf468f7091e5937333ad080e8b6 (patch)
treedd25ff453ac40b26fa8e62188a8ddc68a6159955 /documentation
parent17333a9162fcddce61a330cabf930d3a6e633546 (diff)
downloadpoky-d6ce950527981cf468f7091e5937333ad080e8b6.tar.gz
docs: fix broken links
(From yocto-docs rev: 5139bf1d3ac7f31b711a8410a195ffc88ac560bf) Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst13
-rw-r--r--documentation/dev-manual/dev-manual-qemu.rst2
-rw-r--r--documentation/dev-manual/dev-manual-start.rst10
-rw-r--r--documentation/overview-manual/overview-manual-concepts.rst2
-rw-r--r--documentation/overview-manual/overview-manual-development-environment.rst6
-rw-r--r--documentation/overview-manual/overview-manual-yp-intro.rst2
-rw-r--r--documentation/ref-manual/migration-1.5.rst2
-rw-r--r--documentation/ref-manual/ref-images.rst2
-rw-r--r--documentation/ref-manual/ref-terms.rst2
-rw-r--r--documentation/ref-manual/ref-variables.rst4
-rw-r--r--documentation/sdk-manual/sdk-appendix-obtain.rst6
-rw-r--r--documentation/sdk-manual/sdk-extensible.rst2
-rw-r--r--documentation/sdk-manual/sdk-intro.rst4
-rw-r--r--documentation/sdk-manual/sdk-using.rst2
14 files changed, 30 insertions, 29 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index 5eb7c51644..179979c763 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -10746,14 +10746,15 @@ varies by component:
10746 `bitbake-devel <http://lists.openembedded.org/mailman/listinfo/bitbake-devel>`__ 10746 `bitbake-devel <http://lists.openembedded.org/mailman/listinfo/bitbake-devel>`__
10747 mailing list. 10747 mailing list.
10748 10748
10749- *"meta-*" trees:* These trees contain Metadata. Use the 10749- *"meta-\*" trees:* These trees contain Metadata. Use the
10750 `poky <https://lists.yoctoproject.org/listinfo/poky>`__ mailing list. 10750 `poky <https://lists.yoctoproject.org/g/poky>`__ mailing list.
10751
10752- *Documentation*: For changes to the Yocto Project documentation, use the `docs
10753 <https://lists.yoctoproject.org/g/docs>`__ mailing list.
10751 10754
10752For changes to other layers hosted in the Yocto Project source 10755For changes to other layers hosted in the Yocto Project source
10753repositories (i.e. ``yoctoproject.org``), tools, and the Yocto Project 10756repositories (i.e. ``yoctoproject.org``) and tools use the `Yocto Project
10754documentation, use the `Yocto 10757<https://lists.yoctoproject.org/g/yocto/>`__ general mailing list.
10755Project <https://lists.yoctoproject.org/listinfo/yocto>`__ general
10756mailing list.
10757 10758
10758.. note:: 10759.. note::
10759 10760
diff --git a/documentation/dev-manual/dev-manual-qemu.rst b/documentation/dev-manual/dev-manual-qemu.rst
index 88b03745f4..2833689d5f 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:
81 your :term:`Build Directory`. 81 your :term:`Build Directory`.
82 82
83 - If you have not built an image, you can go to the 83 - If you have not built an image, you can go to the
84 :yocto_dl:`machines/qemu <releases/yocto/yocto-3.1.2/machines/qemu/>` area and download a 84 :yocto_dl:`machines/qemu </releases/yocto/yocto-3.1.2/machines/qemu/>` area and download a
85 pre-built image that matches your architecture and can be run on 85 pre-built image that matches your architecture and can be run on
86 QEMU. 86 QEMU.
87 87
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst
index 536d5a9cd9..d9c1e4de00 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -380,7 +380,7 @@ as your Yocto Project build host:
380 Depending on your build host, you might have to install different 380 Depending on your build host, you might have to install different
381 software to support Docker containers. Go to the Docker installation 381 software to support Docker containers. Go to the Docker installation
382 page and read about the platform requirements in "`Supported 382 page and read about the platform requirements in "`Supported
383 Platforms <https://docs.docker.com/install/#supported-platforms>`__" 383 Platforms <https://docs.docker.com/engine/install/#supported-platforms>`__"
384 your build host needs to run containers. 384 your build host needs to run containers.
385 385
3862. *Choose What To Install:* Depending on whether or not your build host 3862. *Choose What To Install:* Depending on whether or not your build host
@@ -402,11 +402,11 @@ as your Yocto Project build host:
402 type of the software you need to install: 402 type of the software you need to install:
403 403
404 - Install `Docker CE for 404 - Install `Docker CE for
405 Windows <https://docs.docker.com/docker-for-windows/install/#install-docker-for-windows-desktop-app>`__ 405 Windows <https://docs.docker.com/docker-for-windows/install/#install-docker-desktop-on-windows>`__
406 for Windows build hosts that meet requirements. 406 for Windows build hosts that meet requirements.
407 407
408 - Install `Docker CE for 408 - Install `Docker CE for
409 Macs <https://docs.docker.com/docker-for-mac/install/#install-and-run-docker-for-mac>`__ 409 MacOs <https://docs.docker.com/docker-for-mac/install/#install-and-run-docker-desktop-on-mac>`__
410 for Mac build hosts that meet requirements. 410 for Mac build hosts that meet requirements.
411 411
412 - Install `Docker Toolbox for 412 - Install `Docker Toolbox for
@@ -619,7 +619,7 @@ Use the following procedure to locate the latest upstream copy of the
619 619
6203. *Find the URL Used to Clone the Repository:* At the bottom of the 6203. *Find the URL Used to Clone the Repository:* At the bottom of the
621 page, note the URL used to clone that repository 621 page, note the URL used to clone that repository
622 (e.g. :yocto_git:`/git/poky`). 622 (e.g. :yocto_git:`/cgit.cgi/poky`).
623 623
624 .. note:: 624 .. note::
625 625
@@ -647,7 +647,7 @@ of a given component.
647Follow these steps to locate and download a particular tarball: 647Follow these steps to locate and download a particular tarball:
648 648
6491. *Access the Index of Releases:* Open a browser and go to 6491. *Access the Index of Releases:* Open a browser and go to
650 :yocto_dl:`Index of Releases <releases>`. The 650 :yocto_dl:`Index of Releases </releases>`. The
651 list represents released components (e.g. ``bitbake``, ``sato``, and 651 list represents released components (e.g. ``bitbake``, ``sato``, and
652 so on). 652 so on).
653 653
diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst
index 3d8dc7afd1..6ce5f80af3 100644
--- a/documentation/overview-manual/overview-manual-concepts.rst
+++ b/documentation/overview-manual/overview-manual-concepts.rst
@@ -153,7 +153,7 @@ several pieces of hardware.
153 153
154Many layers exist that work in the Yocto Project development 154Many layers exist that work in the Yocto Project development
155environment. The `Yocto Project Curated Layer 155environment. The `Yocto Project Curated Layer
156Index <https://caffelli-staging.yoctoproject.org/software-overview/layers/>`__ 156Index <https://www.yoctoproject.org/software-overview/layers/>`__
157and `OpenEmbedded Layer 157and `OpenEmbedded Layer
158Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__ 158Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__
159both contain layers from which you can use or leverage. 159both contain layers from which you can use or leverage.
diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst
index 3b5147d732..bb2c8e72e7 100644
--- a/documentation/overview-manual/overview-manual-development-environment.rst
+++ b/documentation/overview-manual/overview-manual-development-environment.rst
@@ -43,7 +43,7 @@ Wikipedia has a good historical description of the Open Source
43Philosophy `here <http://en.wikipedia.org/wiki/Open_source>`__. You can 43Philosophy `here <http://en.wikipedia.org/wiki/Open_source>`__. You can
44also find helpful information on how to participate in the Linux 44also find helpful information on how to participate in the Linux
45Community 45Community
46`here <http://ldn.linuxfoundation.org/book/how-participate-linux-community>`__. 46`here <https://www.kernel.org/doc/html/latest/process/index.html>`__.
47 47
48.. _gs-the-development-host: 48.. _gs-the-development-host:
49 49
@@ -185,7 +185,7 @@ development:
185 see the ":ref:`dev-manual/dev-manual-start:accessing source repositories`" 185 see the ":ref:`dev-manual/dev-manual-start:accessing source repositories`"
186 Section in the Yocto Project Development Tasks Manual. 186 Section in the Yocto Project Development Tasks Manual.
187 187
188- :yocto_dl:`Index of /releases: <releases>` This is an index 188- :yocto_dl:`Index of /releases: </releases>` This is an index
189 of releases such as Poky, Pseudo, installers for cross-development 189 of releases such as Poky, Pseudo, installers for cross-development
190 toolchains, miscellaneous support and all released versions of Yocto 190 toolchains, miscellaneous support and all released versions of Yocto
191 Project in the form of images or tarballs. Downloading and extracting 191 Project in the form of images or tarballs. Downloading and extracting
@@ -205,7 +205,7 @@ development:
205 through the "SOFTWARE" menu that allows you to download any Yocto 205 through the "SOFTWARE" menu that allows you to download any Yocto
206 Project release, tool, and Board Support Package (BSP) in tarball 206 Project release, tool, and Board Support Package (BSP) in tarball
207 form. The tarballs are similar to those found in the 207 form. The tarballs are similar to those found in the
208 :yocto_dl:`Index of /releases: <releases>` area. 208 :yocto_dl:`Index of /releases: </releases>` area.
209 209
210 .. image:: figures/yp-download.png 210 .. image:: figures/yp-download.png
211 :align: center 211 :align: center
diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst
index 265fbda7fc..5cdab7ca4a 100644
--- a/documentation/overview-manual/overview-manual-yp-intro.rst
+++ b/documentation/overview-manual/overview-manual-yp-intro.rst
@@ -224,7 +224,7 @@ your Metadata, the easier it is to cope with future changes.
224 possible. 224 possible.
225 225
226 - Familiarize yourself with the `Yocto Project curated layer 226 - Familiarize yourself with the `Yocto Project curated layer
227 index <https://caffelli-staging.yoctoproject.org/software-overview/layers/>`__ 227 index <https://www.yoctoproject.org/software-overview/layers/>`__
228 or the `OpenEmbedded layer 228 or the `OpenEmbedded layer
229 index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__. 229 index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
230 The latter contains more layers but they are less universally 230 The latter contains more layers but they are less universally
diff --git a/documentation/ref-manual/migration-1.5.rst b/documentation/ref-manual/migration-1.5.rst
index ce55199df3..fa6ff92f10 100644
--- a/documentation/ref-manual/migration-1.5.rst
+++ b/documentation/ref-manual/migration-1.5.rst
@@ -185,7 +185,7 @@ been introduced. You can find some of the implications for this change
185`here <http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873>`__. 185`here <http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873>`__.
186The change also means that recipes that install files to ``/var/run`` 186The change also means that recipes that install files to ``/var/run``
187must be changed. You can find a guide on how to make these changes 187must be changed. You can find a guide on how to make these changes
188`here <http://permalink.gmane.org/gmane.comp.handhelds.openembedded/58530>`__. 188`here <https://www.mail-archive.com/openembedded-devel@lists.openembedded.org/msg31649.html>`__.
189 189
190.. _migration-1.5-removal-of-package-manager-database-within-image-recipes: 190.. _migration-1.5-removal-of-package-manager-database-within-image-recipes:
191 191
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst
index f0229c3bb7..c88d4d75ca 100644
--- a/documentation/ref-manual/ref-images.rst
+++ b/documentation/ref-manual/ref-images.rst
@@ -42,7 +42,7 @@ Following is a list of supported recipes:
42 `VMware 42 `VMware
43 Workstation <http://www.vmware.com/products/workstation/overview.html>`__. 43 Workstation <http://www.vmware.com/products/workstation/overview.html>`__.
44 For more information on this image, see the :yocto_home:`Build 44 For more information on this image, see the :yocto_home:`Build
45 Appliance <software-item/build-appliance>` page 45 Appliance </software-item/build-appliance>` page
46 on the Yocto Project website. 46 on the Yocto Project website.
47 47
48- ``core-image-base``: A console-only image that fully supports the 48- ``core-image-base``: A console-only image that fully supports the
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index 6e7e5169ce..600cc23c3e 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -355,7 +355,7 @@ universal, the list includes them just in case:
355 the Source Directory, if you do, the top-level directory name of the 355 the Source Directory, if you do, the top-level directory name of the
356 Source Directory is derived from the Yocto Project release tarball. 356 Source Directory is derived from the Yocto Project release tarball.
357 For example, downloading and unpacking 357 For example, downloading and unpacking
358 :yocto_dl:`releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2` 358 :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2`
359 results in a Source Directory whose root folder is named ``poky``. 359 results in a Source Directory whose root folder is named ``poky``.
360 360
361 It is important to understand the differences between the Source 361 It is important to understand the differences between the Source
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 625a37c158..c49c208bc0 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -696,7 +696,7 @@ system and gives an overview of their function and contents.
696 compiler. Consequently, the syntax follows Python's Regular 696 compiler. Consequently, the syntax follows Python's Regular
697 Expression (re) syntax. The expressions are compared against the full 697 Expression (re) syntax. The expressions are compared against the full
698 paths to the files. For complete syntax information, see Python's 698 paths to the files. For complete syntax information, see Python's
699 documentation at http://docs.python.org/3/library/re.html#re. 699 documentation at https://docs.python.org/3/library/re.html#regular-expression-syntax.
700 700
701 The following example uses a complete regular expression to tell 701 The following example uses a complete regular expression to tell
702 BitBake to ignore all recipe and recipe append files in the 702 BitBake to ignore all recipe and recipe append files in the
@@ -3669,7 +3669,7 @@ system and gives an overview of their function and contents.
3669 The value in ``INITSCRIPT_PARAMS`` is passed through to the 3669 The value in ``INITSCRIPT_PARAMS`` is passed through to the
3670 ``update-rc.d`` command. For more information on valid parameters, 3670 ``update-rc.d`` command. For more information on valid parameters,
3671 please see the ``update-rc.d`` manual page at 3671 please see the ``update-rc.d`` manual page at
3672 http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d. 3672 https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html
3673 3673
3674 INSANE_SKIP 3674 INSANE_SKIP
3675 Specifies the QA checks to skip for a specific package within a 3675 Specifies the QA checks to skip for a specific package within a
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst
index ffaed9deef..97ab9169ea 100644
--- a/documentation/sdk-manual/sdk-appendix-obtain.rst
+++ b/documentation/sdk-manual/sdk-appendix-obtain.rst
@@ -17,7 +17,7 @@ and then run the script to hand-install the toolchain.
17Follow these steps to locate and hand-install the toolchain: 17Follow these steps to locate and hand-install the toolchain:
18 18
191. *Go to the Installers Directory:* Go to 191. *Go to the Installers Directory:* Go to
20 :yocto_dl:`releases/yocto/yocto-3.1.2/toolchain/` 20 :yocto_dl:`/releases/yocto/yocto-3.1.2/toolchain/`
21 21
222. *Open the Folder for Your Build Host:* Open the folder that matches 222. *Open the Folder for Your Build Host:* Open the folder that matches
23 your :term:`Build Host` (i.e. 23 your :term:`Build Host` (i.e.
@@ -204,7 +204,7 @@ Follow these steps to extract the root filesystem:
204 Image File:* You need to find and download the root filesystem image 204 Image File:* You need to find and download the root filesystem image
205 file that is appropriate for your target system. These files are kept 205 file that is appropriate for your target system. These files are kept
206 in machine-specific folders in the 206 in machine-specific folders in the
207 :yocto_dl:`Index of Releases <releases/yocto/yocto-3.1.2/machines/>` 207 :yocto_dl:`Index of Releases </releases/yocto/yocto-3.1.2/machines/>`
208 in the "machines" directory. 208 in the "machines" directory.
209 209
210 The machine-specific folders of the "machines" directory contain 210 The machine-specific folders of the "machines" directory contain
@@ -258,7 +258,7 @@ Follow these steps to extract the root filesystem:
258 258
259 Following is an example command that extracts the root filesystem 259 Following is an example command that extracts the root filesystem
260 from a previously built root filesystem image that was downloaded 260 from a previously built root filesystem image that was downloaded
261 from the :yocto_dl:`Index of Releases <releases/yocto/yocto-3.1.2/machines/>`. 261 from the :yocto_dl:`Index of Releases </releases/yocto/yocto-3.1.2/machines/>`.
262 This command extracts the root filesystem into the ``core2-64-sato`` 262 This command extracts the root filesystem into the ``core2-64-sato``
263 directory: 263 directory:
264 :: 264 ::
diff --git a/documentation/sdk-manual/sdk-extensible.rst b/documentation/sdk-manual/sdk-extensible.rst
index 1ad5c46bea..0f92ac9f0c 100644
--- a/documentation/sdk-manual/sdk-extensible.rst
+++ b/documentation/sdk-manual/sdk-extensible.rst
@@ -51,7 +51,7 @@ Host` by running the ``*.sh`` installation script.
51You can download a tarball installer, which includes the pre-built 51You can download a tarball installer, which includes the pre-built
52toolchain, the ``runqemu`` script, the internal build system, 52toolchain, the ``runqemu`` script, the internal build system,
53``devtool``, and support files from the appropriate 53``devtool``, and support files from the appropriate
54:yocto_dl:`toolchain <releases/yocto/yocto-3.1.2/toolchain/>` directory within the Index of 54:yocto_dl:`toolchain </releases/yocto/yocto-3.1.2/toolchain/>` directory within the Index of
55Releases. Toolchains are available for several 32-bit and 64-bit 55Releases. Toolchains are available for several 32-bit and 64-bit
56architectures with the ``x86_64`` directories, respectively. The 56architectures with the ``x86_64`` directories, respectively. The
57toolchains the Yocto Project provides are based off the 57toolchains the Yocto Project provides are based off the
diff --git a/documentation/sdk-manual/sdk-intro.rst b/documentation/sdk-manual/sdk-intro.rst
index 2e01cf1365..82b7bcf3cf 100644
--- a/documentation/sdk-manual/sdk-intro.rst
+++ b/documentation/sdk-manual/sdk-intro.rst
@@ -195,7 +195,7 @@ You just need to follow these general steps:
195 root filesystem images. 195 root filesystem images.
196 196
197 If you are going to develop your application on hardware, go to the 197 If you are going to develop your application on hardware, go to the
198 :yocto_dl:`machines <releases/yocto/yocto-3.1.2/machines/>` download area and choose a 198 :yocto_dl:`machines </releases/yocto/yocto-3.1.2/machines/>` download area and choose a
199 target machine area from which to download the kernel image and root 199 target machine area from which to download the kernel image and root
200 filesystem. This download area could have several files in it that 200 filesystem. This download area could have several files in it that
201 support development using actual hardware. For example, the area 201 support development using actual hardware. For example, the area
@@ -205,7 +205,7 @@ You just need to follow these general steps:
205 205
206 If you are going to develop your application and then run and test it 206 If you are going to develop your application and then run and test it
207 using the QEMU emulator, go to the 207 using the QEMU emulator, go to the
208 :yocto_dl:`machines/qemu <releases/yocto/yocto-3.1.2/machines/qemu>` download area. From this 208 :yocto_dl:`machines/qemu </releases/yocto/yocto-3.1.2/machines/qemu>` download area. From this
209 area, go down into the directory for your target architecture (e.g. 209 area, go down into the directory for your target architecture (e.g.
210 ``qemux86_64`` for an Intel-based 64-bit architecture). Download the 210 ``qemux86_64`` for an Intel-based 64-bit architecture). Download the
211 kernel, root filesystem, and any other files you need for your 211 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 cd57f07eeb..09a194cab5 100644
--- a/documentation/sdk-manual/sdk-using.rst
+++ b/documentation/sdk-manual/sdk-using.rst
@@ -47,7 +47,7 @@ Host` by running the ``*.sh`` installation script.
47 47
48You can download a tarball installer, which includes the pre-built 48You can download a tarball installer, which includes the pre-built
49toolchain, the ``runqemu`` script, and support files from the 49toolchain, the ``runqemu`` script, and support files from the
50appropriate :yocto_dl:`toolchain <releases/yocto/yocto-3.1.2/toolchain/>` directory within 50appropriate :yocto_dl:`toolchain </releases/yocto/yocto-3.1.2/toolchain/>` directory within
51the Index of Releases. Toolchains are available for several 32-bit and 51the Index of Releases. Toolchains are available for several 32-bit and
5264-bit architectures with the ``x86_64`` directories, respectively. The 5264-bit architectures with the ``x86_64`` directories, respectively. The
53toolchains the Yocto Project provides are based off the 53toolchains the Yocto Project provides are based off the