From d6ce950527981cf468f7091e5937333ad080e8b6 Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Thu, 17 Sep 2020 23:09:47 +0200 Subject: docs: fix broken links (From yocto-docs rev: 5139bf1d3ac7f31b711a8410a195ffc88ac560bf) Signed-off-by: Quentin Schulz Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-common-tasks.rst | 13 +++++++------ documentation/dev-manual/dev-manual-qemu.rst | 2 +- documentation/dev-manual/dev-manual-start.rst | 10 +++++----- documentation/overview-manual/overview-manual-concepts.rst | 2 +- .../overview-manual-development-environment.rst | 6 +++--- documentation/overview-manual/overview-manual-yp-intro.rst | 2 +- documentation/ref-manual/migration-1.5.rst | 2 +- documentation/ref-manual/ref-images.rst | 2 +- documentation/ref-manual/ref-terms.rst | 2 +- documentation/ref-manual/ref-variables.rst | 4 ++-- documentation/sdk-manual/sdk-appendix-obtain.rst | 6 +++--- documentation/sdk-manual/sdk-extensible.rst | 2 +- documentation/sdk-manual/sdk-intro.rst | 4 ++-- documentation/sdk-manual/sdk-using.rst | 2 +- 14 files changed, 30 insertions(+), 29 deletions(-) (limited to 'documentation') 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: `bitbake-devel `__ mailing list. -- *"meta-*" trees:* These trees contain Metadata. Use the - `poky `__ mailing list. +- *"meta-\*" trees:* These trees contain Metadata. Use the + `poky `__ mailing list. + +- *Documentation*: For changes to the Yocto Project documentation, use the `docs + `__ mailing list. For changes to other layers hosted in the Yocto Project source -repositories (i.e. ``yoctoproject.org``), tools, and the Yocto Project -documentation, use the `Yocto -Project `__ general -mailing list. +repositories (i.e. ``yoctoproject.org``) and tools use the `Yocto Project +`__ general mailing list. .. note:: 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: 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/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: Depending on your build host, you might have to install different software to support Docker containers. Go to the Docker installation page and read about the platform requirements in "`Supported - Platforms `__" + Platforms `__" your build host needs to run containers. 2. *Choose What To Install:* Depending on whether or not your build host @@ -402,11 +402,11 @@ as your Yocto Project build host: type of the software you need to install: - Install `Docker CE for - Windows `__ + Windows `__ for Windows build hosts that meet requirements. - Install `Docker CE for - Macs `__ + MacOs `__ for Mac build hosts that meet requirements. - Install `Docker Toolbox for @@ -619,7 +619,7 @@ Use the following procedure to locate the latest upstream copy of the 3. *Find the URL Used to Clone the Repository:* At the bottom of the page, note the URL used to clone that repository - (e.g. :yocto_git:`/git/poky`). + (e.g. :yocto_git:`/cgit.cgi/poky`). .. note:: @@ -647,7 +647,7 @@ of a given component. Follow these steps to locate and download a particular tarball: 1. *Access the Index of Releases:* Open a browser and go to - :yocto_dl:`Index of Releases `. The + :yocto_dl:`Index of Releases `. The list represents released components (e.g. ``bitbake``, ``sato``, and so on). 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. Many layers exist that work in the Yocto Project development environment. The `Yocto Project Curated Layer -Index `__ +Index `__ and `OpenEmbedded Layer Index `__ both 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 Philosophy `here `__. You can also find helpful information on how to participate in the Linux Community -`here `__. +`here `__. .. _gs-the-development-host: @@ -185,7 +185,7 @@ development: see the ":ref:`dev-manual/dev-manual-start:accessing source repositories`" Section in the Yocto Project Development Tasks Manual. -- :yocto_dl:`Index of /releases: ` This is an index +- :yocto_dl:`Index of /releases: ` This is an index of releases such as Poky, Pseudo, installers for cross-development toolchains, miscellaneous support and all released versions of Yocto Project in the form of images or tarballs. Downloading and extracting @@ -205,7 +205,7 @@ development: through the "SOFTWARE" menu that allows you to download any Yocto Project release, tool, and Board Support Package (BSP) in tarball form. The tarballs are similar to those found in the - :yocto_dl:`Index of /releases: ` area. + :yocto_dl:`Index of /releases: ` area. .. image:: figures/yp-download.png :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. possible. - Familiarize yourself with the `Yocto Project curated layer - index `__ + index `__ or the `OpenEmbedded layer index `__. 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 `here `__. The change also means that recipes that install files to ``/var/run`` must be changed. You can find a guide on how to make these changes -`here `__. +`here `__. .. _migration-1.5-removal-of-package-manager-database-within-image-recipes: 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: `VMware Workstation `__. For more information on this image, see the :yocto_home:`Build - Appliance ` page + Appliance ` page on the Yocto Project website. - ``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: the Source Directory, if you do, the top-level directory name of the Source Directory is derived from the Yocto Project release tarball. For example, downloading and unpacking - :yocto_dl:`releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2` + :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2` results in a Source Directory whose root folder is named ``poky``. 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. compiler. Consequently, the syntax follows Python's Regular Expression (re) syntax. The expressions are compared against the full paths to the files. For complete syntax information, see Python's - documentation at http://docs.python.org/3/library/re.html#re. + documentation at https://docs.python.org/3/library/re.html#regular-expression-syntax. The following example uses a complete regular expression to tell 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. The value in ``INITSCRIPT_PARAMS`` is passed through to the ``update-rc.d`` command. For more information on valid parameters, please see the ``update-rc.d`` manual page at - http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d. + https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html INSANE_SKIP 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. 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-3.1.2/toolchain/` 2. *Open the Folder for Your Build Host:* Open the folder that matches your :term:`Build Host` (i.e. @@ -204,7 +204,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 @@ -258,7 +258,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: :: 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. 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 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: 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 @@ -205,7 +205,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 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. 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 -- cgit v1.2.3-54-g00ecf