From 283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 30 Jul 2020 11:00:01 +0200 Subject: sphinx: add links for Yocto project website In DocBook, variables are used to create custom links (note that it is not consistent everywhere, since some web addresses are still hardcoded), such as YOCTO_HOME_URL, YOCTO_GIT_URL, YOCTO_WIKI_URL, YOCTO_BUGS_URL and YOCTO_DL_URL.. In Sphinx they are replaced with extlinks. (From yocto-docs rev: d25f3095a9d29a3355581d0743f27b2a423ad580) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/boilerplate.rst | 6 ++-- .../brief-yoctoprojectqs/brief-yoctoprojectqs.rst | 10 +++--- documentation/bsp-guide/bsp.rst | 40 +++++++++++----------- .../dev-manual/dev-manual-common-tasks.rst | 35 +++++++++---------- documentation/dev-manual/dev-manual-intro.rst | 4 +-- documentation/dev-manual/dev-manual-start.rst | 21 ++++++------ documentation/kernel-dev/kernel-dev-advanced.rst | 6 ++-- documentation/kernel-dev/kernel-dev-common.rst | 6 ++-- .../kernel-dev/kernel-dev-concepts-appx.rst | 2 +- documentation/kernel-dev/kernel-dev-intro.rst | 6 ++-- documentation/kernel-dev/kernel-dev-maint-appx.rst | 16 ++++----- .../overview-manual/overview-manual-concepts.rst | 12 +++---- .../overview-manual-development-environment.rst | 25 +++++++------- .../overview-manual/overview-manual-intro.rst | 4 +-- .../overview-manual/overview-manual-yp-intro.rst | 15 ++++---- documentation/ref-manual/faq.rst | 13 ++++--- documentation/ref-manual/migration.rst | 4 +-- documentation/ref-manual/ref-classes.rst | 2 +- documentation/ref-manual/ref-images.rst | 4 +-- .../ref-manual/ref-system-requirements.rst | 10 +++--- documentation/ref-manual/ref-tasks.rst | 2 +- documentation/ref-manual/ref-terms.rst | 5 ++- documentation/ref-manual/ref-variables.rst | 12 +++---- documentation/ref-manual/resources.rst | 20 +++++------ documentation/sdk-manual/sdk-appendix-obtain.rst | 4 +-- documentation/test-manual/test-manual-intro.rst | 2 +- .../toaster-manual/toaster-manual-reference.rst | 8 ++--- 27 files changed, 140 insertions(+), 154 deletions(-) diff --git a/documentation/boilerplate.rst b/documentation/boilerplate.rst index d9cb7a263d..a885f0eb10 100644 --- a/documentation/boilerplate.rst +++ b/documentation/boilerplate.rst @@ -14,7 +14,7 @@ Commons. * This version of this *manual* is for the |YOCTO_DOC_VERSION| release of the Yocto Project. To be sure you have the latest version of the manual for this - release, go to the :yocto_home:`Yocto Project documentation page ` and + release, go to the :yocto_home:`Yocto Project documentation page ` and select the manual from that site. Manuals from the site are more up-to-date than manuals derived from the Yocto Project released TAR files. @@ -22,9 +22,9 @@ Commons. might not be the one you want (e.g. the search might have returned a manual much older than the Yocto Project version with which you are working). You can see all Yocto Project major releases by visiting the - :yocto_wiki:`Releases` page. If you need a version of this + :yocto_wiki:`Releases` page. If you need a version of this manual for a different Yocto Project release, visit the :yocto_home:`Yocto - Project documentation page` and select the manual set by using the + Project documentation page` and select the manual set by using the "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" pull-down menus. * To report any inaccuracies or problems with this (or any other Yocto diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst index 563c3f2d9a..8af70b4d46 100644 --- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst +++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.rst @@ -138,8 +138,8 @@ an entire Linux distribution, including the toolchain, from source. - If you do not know your proxy settings, consult your local network infrastructure resources and get that information. A good starting point could also be to check your web browser settings. Finally, - you can find more information on the "`Working Behind a Network - Proxy `__" + you can find more information on the + ":yocto_wiki:`Working Behind a Network Proxy `" page of the Yocto Project Wiki. 1. *Initialize the Build Environment:* From within the ``poky`` @@ -239,7 +239,7 @@ modular development and makes it easier to reuse the layer metadata. Follow these steps to add a hardware layer: 1. *Find a Layer:* Lots of hardware layers exist. The Yocto Project - `Source Repositories <&YOCTO_GIT_URL;>`__ has many hardware layers. + :yocto_git:`Source Repositories <>` has many hardware layers. This example adds the `meta-altera `__ hardware layer. @@ -324,7 +324,7 @@ Now that you have experienced using the Yocto Project, you might be asking yourself "What now?" The Yocto Project has many sources of information including the website, wiki pages, and user manuals: -- *Website:* The `Yocto Project Website <&YOCTO_HOME_URL;>`__ provides +- *Website:* The :yocto_home:`Yocto Project Website <>` provides background information, the latest builds, breaking news, full development documentation, and access to a rich Yocto Project Development Community into which you can tap. @@ -343,7 +343,7 @@ information including the website, wiki pages, and user manuals: The manual also provides conceptual information for various aspects of the Yocto Project. -- *Yocto Project Wiki:* The `Yocto Project Wiki <&YOCTO_WIKI_URL;>`__ +- *Yocto Project Wiki:* The :yocto_wiki:`Yocto Project Wiki <>` provides additional information on where to go next when ramping up with the Yocto Project, release information, project planning, and QA information. diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index 361951b592..9a12c942bc 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst @@ -43,7 +43,7 @@ To help understand the BSP layer concept, consider the BSPs that the Yocto Project supports and provides with each release. You can see the layers in the `Yocto Project Source Repositories <&YOCTO_DOCS_OM_URL;#yocto-project-repositories>`__ through -a web interface at ` <&YOCTO_GIT_URL;>`__. If you go to that interface, +a web interface at :yocto_git:`/`. If you go to that interface, you will find a list of repositories under "Yocto Metadata Layers". .. note:: @@ -270,7 +270,7 @@ meta-bsp_root_name/recipes-graphics/\* meta-bsp_root_name/recipes-kernel/linux/linux-yocto_kernel_rev.bbappend Below is an example of the Raspberry Pi BSP layer that is available from -the `Source Respositories <&YOCTO_GIT_URL;>`__: +the :yocto_git:`Source Respositories <>`: meta-raspberrypi/COPYING.MIT meta-raspberrypi/README.md meta-raspberrypi/classes meta-raspberrypi/classes/sdcard_image-rpi.bbclass meta-raspberrypi/conf/ @@ -487,7 +487,7 @@ This optional area contains useful pre-built kernels and user-space filesystem images released with the BSP that are appropriate to the target system. This directory typically contains graphical (e.g. Sato) and minimal live images when the BSP tarball has been created and made -available in the `Yocto Project <&YOCTO_HOME_URL;>`__ website. You can +available in the :yocto_home:`Yocto Project <>` website. You can use these kernels and images to get a system running and quickly get started on development tasks. @@ -871,13 +871,13 @@ Yocto Project: ``meta-``\ bsp_root_name directory. This license covers the BSP Metadata as a whole. You must specify which license to use since no default license exists when one is not specified. See the - ```COPYING.MIT`` <&YOCTO_GIT_URL;/cgit.cgi/meta-raspberrypi/tree/COPYING.MIT>`__ + :yocto_git:`COPYING.MIT ` file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer as an example. - *README File:* You must include a ``README`` file in the ``meta-``\ bsp_root_name directory. See the - ```README.md`` <&YOCTO_GIT_URL;/cgit.cgi/meta-raspberrypi/tree/README.md>`__ + :yocto_git:`README.md ` file for the Raspberry Pi BSP in the ``meta-raspberrypi`` BSP layer as an example. @@ -976,8 +976,8 @@ Yocto Project: - *Use a Yocto Linux Kernel:* Kernel recipes in the BSP should be based on a Yocto Linux kernel. Basing your recipes on these kernels reduces the costs for maintaining the BSP and increases its scalability. See - the ``Yocto Linux Kernel`` category in the `Source - Repositories <&YOCTO_GIT_URL;>`__ for these kernels. + the ``Yocto Linux Kernel`` category in the + :yocto_git:`Source Repositories <>` for these kernels. Customizing a Recipe for a BSP ============================== @@ -1067,7 +1067,7 @@ of the licensed version in the BSP recipe. For cases where you can substitute a free component and still maintain the system's functionality, the "DOWNLOADS" selection from the -"SOFTWARE" tab on the `Yocto Project website <&YOCTO_HOME_URL;>`__ makes +"SOFTWARE" tab on the :yocto_home:`Yocto Project Website <>` makes available de-featured BSPs that are completely free of any IP encumbrances. For these cases, you can use the substitution directly and without any further licensing requirements. If present, these fully @@ -1114,8 +1114,8 @@ list describes them in order of preference: image with no change at all to the normal build process. 2. *Get a Pre-Built Version of the BSP:* You can get this type of BSP by - selecting the "DOWNLOADS" item from the "SOFTWARE" tab on the `Yocto - Project website <&YOCTO_HOME_URL;>`__. You can download BSP tarballs + selecting the "DOWNLOADS" item from the "SOFTWARE" tab on the + :yocto_home:`Yocto Project website <>`. You can download BSP tarballs that contain proprietary components after agreeing to the licensing requirements of each of the individually encumbered packages as part of the download process. Obtaining the BSP this way allows you to @@ -1156,20 +1156,20 @@ Use these steps to create a BSP layer: - *Create a Layer Configuration File:* Every layer needs a layer configuration file. This configuration file establishes locations for the layer's recipes, priorities for the layer, and so forth. You can - find examples of ``layer.conf`` files in the Yocto Project `Source - Repositories <&YOCTO_GIT_URL;>`__. To get examples of what you need + find examples of ``layer.conf`` files in the Yocto Project + :yocto_git:`Source Repositories <>`. To get examples of what you need in your configuration file, locate a layer (e.g. "meta-ti") and examine the - ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-ti/tree/conf/layer.conf>`__ + :yocto_git:`local.conf ` file. - *Create a Machine Configuration File:* Create a ``conf/machine/``\ bsp_root_name\ ``.conf`` file. See - ```meta-yocto-bsp/conf/machine`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf/machine>`__ + :yocto_git:`meta-yocto-bsp/conf/machine ` for sample bsp_root_name\ ``.conf`` files. Other samples such as - ```meta-ti`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-ti/tree/conf/machine>`__ + :yocto_git:`meta-ti ` and - ```meta-freescale`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/tree/conf/machine>`__ + :yocto_git:`meta-freescale ` exist from other vendors that have more specific machine and tuning examples. @@ -1184,7 +1184,7 @@ Use these steps to create a BSP layer: The remainder of this section provides a description of the Yocto Project reference BSP for Beaglebone, which resides in the -```meta-yocto-bsp`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`__ +:yocto_git:`meta-yocto-bsp ` layer. BSP Layer Configuration Example @@ -1199,8 +1199,8 @@ BBFILE_COLLECTIONS += "yoctobsp" BBFILE_PATTERN_yoctobsp = "^${LAYERDIR}/" BBFILE_PRIORITY_yoctobsp = "5" LAYERVERSION_yoctobsp = "4" LAYERSERIES_COMPAT_yoctobsp = "DISTRO_NAME_NO_CAP" The variables used in this file configure the layer. A good way to learn about layer -configuration files is to examine various files for BSP from the `Source -Repositories <&YOCTO_GIT_URL;>`__. +configuration files is to examine various files for BSP from the +:yocto_git:`Source Repositories <>`. For a detailed description of this particular layer configuration file, see "`step 3 <&YOCTO_DOCS_DEV_URL;#dev-layer-config-file-description>`__ @@ -1409,7 +1409,7 @@ PREFERRED_VERSION_linux-yocto ?= "5.0%" The metadata used to build the kernel. In this case, a kernel append file (i.e. ``linux-yocto_5.0.bbappend``) is used to override an established kernel recipe (i.e. ``linux-yocto_5.0.bb``), which is located in -` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/recipes-kernel/linux>`__. +https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/recipes-kernel/linux. Following is the contents of the append file: KBRANCH_genericx86 = "v5.0/standard/base" KBRANCH_genericx86-64 = "v5.0/standard/base" diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst index 29a94b9a84..0703f3ebc8 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.rst +++ b/documentation/dev-manual/dev-manual-common-tasks.rst @@ -68,8 +68,7 @@ Follow these general steps to create your layer without using tools: ``conf`` directory and then modify the file as needed. The ``meta-yocto-bsp/conf/layer.conf`` file in the Yocto Project - `Source - Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp/conf>`__ + :yocto_git:`Source Repositories ` demonstrates the required syntax. For your layer, you need to replace "yoctobsp" with a unique identifier for your layer (e.g. "machinexyz" for a layer named "meta-machinexyz"): # We have a conf and classes @@ -120,7 +119,7 @@ Follow these general steps to create your layer without using tools: Lists all layers on which this layer depends (if any). - :term:`LAYERSERIES_COMPAT`: - Lists the `Yocto Project <&YOCTO_WIKI_URL;/wiki/Releases>`__ + Lists the :yocto_wiki:`Yocto Project ` releases for which the current version is compatible. This variable is a good way to indicate if your particular layer is current. @@ -4001,9 +4000,9 @@ your tunings to best consider build times and package feed maintenance. higher levels noted earlier can be useful. For example, consider how NXP (formerly Freescale) allows for the easy reuse of binary packages in their layer - ```meta-freescale`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/>`__. + :yocto_git:`meta-freescale `. In this example, the - ```fsl-dynamic-packagearch`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/meta-freescale/tree/classes/fsl-dynamic-packagearch.bbclass>`__ + :yocto_git:`fsl-dynamic-packagearch ` class shares GPU packages for i.MX53 boards because all boards share the AMD GPU. The i.MX6-based boards can do the same because all boards share the Vivante GPU. This class inspects the BitBake @@ -5058,7 +5057,7 @@ partition. Source plugins are subclasses defined in plugin files. As shipped, the Yocto Project provides several plugin files. You can see the source plugin files that ship with the Yocto Project -`here <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/scripts/lib/wic/plugins/source>`__. +:yocto_git:`here `. Each of these plugin files contains source plugins that are designed to populate a specific Wic image partition. @@ -5591,8 +5590,8 @@ Tools for Hardening Your Image ------------------------------ The Yocto Project provides tools for making your image more secure. You -can find these tools in the ``meta-security`` layer of the `Yocto -Project Source Repositories <&YOCTO_GIT_URL;>`__. +can find these tools in the ``meta-security`` layer of the +:yocto_git:`Yocto Project Source Repositories <>`. Creating Your Own Distribution ============================== @@ -5872,7 +5871,7 @@ the following: build system uses this string to help define the value of ``PV`` when the source code revision needs to be included in it. -- `PR Service `__: A +- :yocto_wiki:`PR Service `: A network-based service that helps automate keeping package feeds compatible with existing package manager applications such as RPM, APT, and OPKG. @@ -6574,7 +6573,7 @@ testname where the result can be ``PASS``, ``FAIL``, or ``SKIP``, and the testname can be any identifying string. For a list of Yocto Project recipes that are already enabled with ptest, -see the `Ptest `__ wiki page. +see the :yocto_wiki:`Ptest ` wiki page. .. note:: @@ -9209,10 +9208,9 @@ Here are some other tips that you might find useful: indicate that the documentation should be extended or improved. In such cases, consider filing a documentation bug using the Yocto Project implementation of - `Bugzilla `__. For information on + :yocto_bugs:`Bugzilla <>`. For information on how to submit a bug against the Yocto Project, see the Yocto Project - Bugzilla `wiki - page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__ + Bugzilla :yocto_wiki:`wiki page ` and the "`Submitting a Defect Against the Yocto Project <#submitting-a-defect-against-the-yocto-project>`__" section. @@ -9241,13 +9239,12 @@ against the Yocto Project. For additional information on this implementation of Bugzilla see the "`Yocto Project Bugzilla <&YOCTO_DOCS_REF_URL;#resources-bugtracker>`__" section in the Yocto Project Reference Manual. For more detail on any of the following -steps, see the Yocto Project `Bugzilla wiki -page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__. +steps, see the Yocto Project +:yocto_wiki:`Bugzilla wiki page `. Use the following general steps to submit a bug" -1. Open the Yocto Project implementation of - `Bugzilla <&YOCTO_BUGZILLA_URL;>`__. +1. Open the Yocto Project implementation of :yocto_bugs:`Bugzilla <>`. 2. Click "File a Bug" to enter a new bug. @@ -9365,8 +9362,8 @@ concepts on working in the Yocto Project development environment. Two commonly used testing repositories exist for OpenEmbedded-Core: - *"ross/mut" branch:* The "mut" (master-under-test) tree exists in the - ``poky-contrib`` repository in the `Yocto Project source - repositories <&YOCTO_GIT_URL;>`__. + ``poky-contrib`` repository in the + :yocto_git:`Yocto Project source repositories <>`. - *"master-next" branch:* This branch is part of the main "poky" repository in the Yocto Project source repositories. diff --git a/documentation/dev-manual/dev-manual-intro.rst b/documentation/dev-manual/dev-manual-intro.rst index 492d3db82a..1dc552c750 100644 --- a/documentation/dev-manual/dev-manual-intro.rst +++ b/documentation/dev-manual/dev-manual-intro.rst @@ -53,8 +53,8 @@ Other Information Because this manual presents information for many different topics, supplemental information is recommended for full comprehension. For -introductory information on the Yocto Project, see the `Yocto Project -Website <&YOCTO_HOME_URL;>`__. If you want to build an image with no +introductory information on the Yocto Project, see the +:yocto_home:`Yocto Project Website <>`. If you want to build an image with no knowledge of Yocto Project as a way of quickly testing it out, see the `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst index 81fa7847e6..884d1286ef 100644 --- a/documentation/dev-manual/dev-manual-start.rst +++ b/documentation/dev-manual/dev-manual-start.rst @@ -92,7 +92,7 @@ particular working environment and set of practices. It is relatively easy to set up Git services and create infrastructure like - `http://git.yoctoproject.org <&YOCTO_GIT_URL;>`__, which is based on + :yocto_git:`http://git.yoctoproject.org <>`, which is based on server software called ``gitolite`` with ``cgit`` being used to generate the web interface that lets you view the repositories. The ``gitolite`` software identifies users using SSH keys and allows @@ -322,8 +322,7 @@ Project Build Host: validation and their status, see the "`Supported Linux Distributions <&YOCTO_DOCS_REF_URL;#detailed-supported-distros>`__" section in the Yocto Project Reference Manual and the wiki page at - `Distribution - Support <&YOCTO_WIKI_URL;/wiki/Distribution_Support>`__. + :yocto_wiki:`Distribution Support `. 2. *Have Enough Free Memory:* Your system should have at least 50 Gbytes of free disk space for building images. @@ -598,14 +597,14 @@ Working from a copy of the upstream Yocto Project `Source Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the preferred method for obtaining and using a Yocto Project release. You can view the Yocto Project Source Repositories at -` <&YOCTO_GIT_URL;>`__. In particular, you can find the ``poky`` -repository at ` `__. +:yocto_git:`/`. In particular, you can find the ``poky`` +repository at :yocto_git:`/cgit.cgi/poky`. Use the following procedure to locate the latest upstream copy of the ``poky`` Git repository: 1. *Access Repositories:* Open a browser and go to - ` <&YOCTO_GIT_URL;>`__ to access the GUI-based interface into the + :yocto_git:`/` to access the GUI-based interface into the Yocto Project source repositories. 2. *Select the Repository:* Click on the repository in which you are @@ -614,7 +613,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 <&YOCTO_DOCS_OM_URL;#git-commands-clone>`__ that repository - (e.g. ``YOCTO_GIT_URL/poky``). + (e.g. :yocto_git:`/git/poky`). .. note:: @@ -642,7 +641,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_URL;/releases>`__ to access the Index of Releases. The + :yocto_dl:`Index of Releases `. The list represents released components (e.g. ``bitbake``, ``sato``, and so on). @@ -670,7 +669,7 @@ Follow these steps to locate and download a particular tarball: Using the Downloads Page ------------------------ -The `Yocto Project Website <&YOCTO_HOME_URL;>`__ uses a "DOWNLOADS" page +The :yocto_home:`Yocto Project Website <>` uses a "DOWNLOADS" page from which you can locate and download tarballs of any Yocto Project release. Rather than Git repositories, these files represent snapshot tarballs similar to the tarballs located in the Index of Releases @@ -684,8 +683,8 @@ Releases <#accessing-index-of-releases>`__" section. repository. The procedure in this section exists should you desire a tarball snapshot of any given component. -1. *Go to the Yocto Project Website:* Open The `Yocto Project - Website <&YOCTO_HOME_URL;>`__ in your browser. +1. *Go to the Yocto Project Website:* Open The + :yocto_home:`Yocto Project Website <>` in your browser. 2. *Get to the Downloads Area:* Select the "DOWNLOADS" item from the pull-down "SOFTWARE" tab menu near the top of the page. diff --git a/documentation/kernel-dev/kernel-dev-advanced.rst b/documentation/kernel-dev/kernel-dev-advanced.rst index 36a34ca28c..cef5966ca9 100644 --- a/documentation/kernel-dev/kernel-dev-advanced.rst +++ b/documentation/kernel-dev/kernel-dev-advanced.rst @@ -20,8 +20,8 @@ BSPs and Linux kernel types. Kernel Metadata exists in many places. One area in the Yocto Project `Source Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ is the ``yocto-kernel-cache`` Git repository. You can find this repository -grouped under the "Yocto Linux Kernel" heading in the `Yocto Project -Source Repositories <&YOCTO_GIT_URL;>`__. +grouped under the "Yocto Linux Kernel" heading in the +:yocto_git:`Yocto Project Source Repositories <>`. Kernel development tools ("kern-tools") exist also in the Yocto Project Source Repositories under the "Yocto Linux Kernel" heading in the @@ -188,7 +188,7 @@ either :term:`FILESEXTRAPATHS` if you are creating Metadata in `recipe-space <#recipe-space-metadata>`__, or the top level of -```yocto-kernel-cache`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/>`__ +:yocto_git:`yocto-kernel-cache ` if you are creating `Metadata outside of the recipe-space <#metadata-outside-the-recipe-space>`__. diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst index 813f4047e2..aa9f77de86 100644 --- a/documentation/kernel-dev/kernel-dev-common.rst +++ b/documentation/kernel-dev/kernel-dev-common.rst @@ -286,7 +286,7 @@ section: 5. *Create a Local Copy of the Kernel Git Repository:* You can find Git repositories of supported Yocto Project kernels organized under "Yocto Linux Kernel" in the Yocto Project Source Repositories at - ` <&YOCTO_GIT_URL;>`__. + :yocto_git:`/`. For simplicity, it is recommended that you create your copy of the kernel Git repository outside of the @@ -1404,7 +1404,7 @@ To help you use your own sources, the Yocto Project provides a linux-yocto custom recipe (``linux-yocto-custom.bb``) that uses ``kernel.org`` sources and the Yocto Project Linux kernel tools for managing kernel Metadata. You can find this recipe in the ``poky`` Git -repository of the Yocto Project `Source Repository <&YOCTO_GIT_URL;>`__ +repository of the Yocto Project :yocto_git:`Source Repository <>` at: poky/meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb Here are some basic steps you can use to work with your own sources: @@ -1535,7 +1535,7 @@ Linux kernel sources, if you need an external kernel module, the create your own out-of-tree Linux kernel module recipe. This template recipe is located in the ``poky`` Git repository of the -Yocto Project `Source Repository <&YOCTO_GIT_URL;>`__ at: +Yocto Project :yocto_git:`Source Repository <>` at: poky/meta-skeleton/recipes-kernel/hello-mod/hello-mod_0.1.bb To get started, copy this recipe to your layer and give it a meaningful diff --git a/documentation/kernel-dev/kernel-dev-concepts-appx.rst b/documentation/kernel-dev/kernel-dev-concepts-appx.rst index f65e960046..165cbb9aef 100644 --- a/documentation/kernel-dev/kernel-dev-concepts-appx.rst +++ b/documentation/kernel-dev/kernel-dev-concepts-appx.rst @@ -38,7 +38,7 @@ needs for targeted hardware. You can find a web interface to the Yocto Linux kernels in the `Source Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ at -` <&YOCTO_GIT_URL;>`__. If you look at the interface, you will see to +:yocto_git:`/`. If you look at the interface, you will see to the left a grouping of Git repositories titled "Yocto Linux Kernel". Within this group, you will find several Linux Yocto kernels developed and included with Yocto Project releases: diff --git a/documentation/kernel-dev/kernel-dev-intro.rst b/documentation/kernel-dev/kernel-dev-intro.rst index 4da3af8dae..6708a6afe9 100644 --- a/documentation/kernel-dev/kernel-dev-intro.rst +++ b/documentation/kernel-dev/kernel-dev-intro.rst @@ -20,10 +20,10 @@ Project, and provides insight into how the Yocto Project team develops and maintains Yocto Linux kernel Git repositories and Metadata. Each Yocto Project release has a set of Yocto Linux kernel recipes, -whose Git repositories you can view in the Yocto `Source -Repositories <&YOCTO_GIT_URL;>`__ under the "Yocto Linux Kernel" +whose Git repositories you can view in the Yocto +:yocto_git:`Source Repositories <>` under the "Yocto Linux Kernel" heading. New recipes for the release track the latest Linux kernel -upstream developments from ` `__ and introduce +upstream developments from http://www.kernel.org> and introduce newly-supported platforms. Previous recipes in the release are refreshed and supported for at least one additional Yocto Project release. As they align, these previous releases are updated to include the latest from diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.rst b/documentation/kernel-dev/kernel-dev-maint-appx.rst index c0c0bc260b..0b0cca14a7 100644 --- a/documentation/kernel-dev/kernel-dev-maint-appx.rst +++ b/documentation/kernel-dev/kernel-dev-maint-appx.rst @@ -10,7 +10,7 @@ Tree Construction This section describes construction of the Yocto Project kernel source repositories as accomplished by the Yocto Project team to create Yocto Linux kernel repositories. These kernel repositories are found under the -heading "Yocto Linux Kernel" at `YOCTO_GIT_URL <&YOCTO_GIT_URL;>`__ and +heading "Yocto Linux Kernel" at :yocto_git:`/` and are shipped as part of a Yocto Project release. The team creates these repositories by compiling and executing the set of feature descriptions for every BSP and feature in the product. Those feature descriptions @@ -80,7 +80,7 @@ to the kernel. The following steps describe what happens when the Yocto Project Team constructs the Yocto Project kernel source Git repository (or tree) -found at ` <&YOCTO_GIT_URL;>`__ given the introduction of a new +found at :yocto_git:`/` given the introduction of a new top-level kernel feature or BSP. The following actions effectively provide the Metadata and create the tree that includes the new feature, patch, or BSP: @@ -93,10 +93,9 @@ patch, or BSP: located by searching these system directories: - The in-tree kernel-cache directories, which are located in the - ```yocto-kernel-cache`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache/tree/bsp>`__ + :yocto_git:`yocto-kernel-cache ` repository organized under the "Yocto Linux Kernel" heading in the - `Yocto Project Source - Repositories `__. + :yocto_git:`Yocto Project Source Repositories <>`. - Areas pointed to by ``SRC_URI`` statements found in kernel recipes @@ -143,8 +142,7 @@ specific to some target hardware. as shipped with the Yocto Project release. Any add-ons and configuration data are applied to the end of an existing branch. The full repository generation that is found in the official Yocto - Project kernel repositories at - `http://git.yoctoproject.org <&YOCTO_GIT_URL;>`__ is the + Project kernel repositories at :yocto_git:`/` is the combination of all supported boards and configurations. - The technique the Yocto Project team uses is flexible and allows @@ -152,12 +150,12 @@ specific to some target hardware. patches specific to a deployment. Any additions to the kernel become an integrated part of the branches. - - The full kernel tree that you see on ` <&YOCTO_GIT_URL;>`__ is + - The full kernel tree that you see on :yocto_git:`/` is generated through repeating the above steps for all valid BSPs. The end result is a branched, clean history tree that makes up the kernel for a given release. You can see the script (``kgit-scc``) responsible for this in the - ```yocto-kernel-tools`` <&YOCTO_GIT_URL;/cgit.cgi/yocto-kernel-tools/tree/tools>`__ + :yocto_git:`yocto-kernel-tools ` repository. - The steps used to construct the full kernel tree are the same diff --git a/documentation/overview-manual/overview-manual-concepts.rst b/documentation/overview-manual/overview-manual-concepts.rst index 9764b25b6d..978c2b0b6f 100644 --- a/documentation/overview-manual/overview-manual-concepts.rst +++ b/documentation/overview-manual/overview-manual-concepts.rst @@ -277,7 +277,7 @@ The ``local.conf`` file provides many basic variables that define a build environment. Here is a list of a few. To see the default configurations in a ``local.conf`` file created by the build environment script, see the -```local.conf.sample`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample>`__ +:yocto_git:`local.conf.sample ` in the ``meta-poky`` layer: - *Target Machine Selection:* Controlled by the @@ -397,17 +397,17 @@ figure <#general-workflow-figure>`__: configurations. This type of information is specific to a particular target architecture. A good example of a BSP layer from the `Poky Reference Distribution <#gs-reference-distribution-poky>`__ is the - ```meta-yocto-bsp`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto-bsp>`__ + :yocto_git:`meta-yocto-bsp ` layer. - *Policy Configuration:* Distribution Layers (i.e. "Distro Layer" in the following figure) providing top-level or general policies for the images or SDKs being built for a particular distribution. For example, in the Poky Reference Distribution the distro layer is the - ```meta-poky`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky>`__ + :yocto_git:`meta-poky ` layer. Within the distro layer is a ``conf/distro`` directory that contains distro configuration files (e.g. - ```poky.conf`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/poky.conf>`__ + :yocto_git:`poky.conf ` that contain many policy configurations for the Poky distribution. The following figure shows an expanded representation of these three @@ -901,7 +901,7 @@ This step in the build process consists of the following tasks: variables. For information on how this variable works within that class, see the :ref:`autotools ` class - `here <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/autotools.bbclass>`__. + :yocto_git:`here `. - *``do_compile``*: Once a configuration task has been satisfied, BitBake compiles the source using the @@ -981,7 +981,7 @@ The :term:`FILES` variable defines the files that go into each package in :term:`PACKAGES`. If you want details on how this is accomplished, you can look at -```package.bbclass`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/package.bbclass>`__. +:yocto_git:`package.bbclass `. Depending on the type of packages being created (RPM, DEB, or IPK), the :ref:`do_package_write_* ` diff --git a/documentation/overview-manual/overview-manual-development-environment.rst b/documentation/overview-manual/overview-manual-development-environment.rst index 82562bf995..65ad1d1206 100644 --- a/documentation/overview-manual/overview-manual-development-environment.rst +++ b/documentation/overview-manual/overview-manual-development-environment.rst @@ -143,7 +143,7 @@ Yocto Project Source Repositories ================================= The Yocto Project team maintains complete source repositories for all -Yocto Project files at ` <&YOCTO_GIT_URL;>`__. This web-based source +Yocto Project files at :yocto_git:`/`. This web-based source code browser is organized into categories by function such as IDE Plugins, Matchbox, Poky, Yocto Linux Kernel, and so forth. From the interface, you can click on any particular item in the "Name" column and @@ -155,7 +155,7 @@ history, and ultimately enhance the Yocto Project's tools, Board Support Packages, and so forth. For any supported release of Yocto Project, you can also go to the -`Yocto Project Website <&YOCTO_HOME_URL;>`__ and select the "DOWNLOADS" +:yocto_home:`Yocto Project Website <>` and select the "DOWNLOADS" item from the "SOFTWARE" menu and get a released tarball of the ``poky`` repository, any supported BSP tarball, or Yocto Project tools. Unpacking these tarballs gives you a snapshot of the released files. @@ -176,7 +176,7 @@ these tarballs gives you a snapshot of the released files. In summary, here is where you can get the project files needed for development: -- `Source Repositories: <&YOCTO_GIT_URL;>`__ This area contains IDE +- :yocto_git:`Source Repositories: <>` This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto Metadata Layers. You can create local copies of Git repositories for each of these areas. @@ -189,7 +189,7 @@ development: Repositories <&YOCTO_DOCS_DEV_URL;#accessing-source-repositories>`__" Section in the Yocto Project Development Tasks Manual. -- `Index of /releases: <&YOCTO_DL_URL;/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 @@ -204,14 +204,13 @@ development: Releases <&YOCTO_DOCS_DEV_URL;#accessing-index-of-releases>`__" section in the Yocto Project Development Tasks Manual. -- *"DOWNLOADS" page for the*\ `Yocto Project - Website <&YOCTO_HOME_URL;>`__\ *:* +- *"DOWNLOADS" page for the* :yocto_home:`Yocto Project Website <>` *:* The Yocto Project website includes a "DOWNLOADS" page accessible 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 `Index of - /releases: <&YOCTO_DL_URL;/releases/>`__ area. + form. The tarballs are similar to those found in the + :yocto_dl:`Index of /releases: ` area. .. image:: figures/yp-download.png :align: center @@ -259,8 +258,8 @@ and so forth. The Yocto Project ``poky`` Git repository also has an upstream contribution Git repository named ``poky-contrib``. You can see all the -branches in this repository using the web interface of the `Source -Repositories <&YOCTO_GIT_URL;>`__ organized within the "Poky Support" +branches in this repository using the web interface of the +:yocto_git:`Source Repositories <>` organized within the "Poky Support" area. These branches hold changes (commits) to the project that have been submitted or committed by the Yocto Project development team and by community members who contribute to the project. The maintainer @@ -400,7 +399,7 @@ Repositories, Tags, and Branches As mentioned briefly in the previous section and also in the "`Git Workflows and the Yocto Project <#gs-git-workflows-and-the-yocto-project>`__" section, the Yocto -Project maintains source repositories at ` <&YOCTO_GIT_URL;>`__. If you +Project maintains source repositories at :yocto_git:`/`. If you look at this web-interface of the repositories, each item is a separate Git repository. @@ -432,7 +431,7 @@ files. Git uses "branches" to organize different development efforts. For example, the ``poky`` repository has several branches that include the current "DISTRO_NAME_NO_CAP" branch, the "master" branch, and many branches for past Yocto Project releases. You can see all the branches -by going to ` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the +by going to https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link beneath the "Branch" heading. Each of these branches represents a specific area of development. The @@ -472,7 +471,7 @@ Git uses "tags" to mark specific changes in a repository branch structure. Typically, a tag is used to mark a special point such as the final change (or commit) before a project is released. You can see the tags used with the ``poky`` Git repository by going to -` <&YOCTO_GIT_URL;/cgit.cgi/poky/>`__ and clicking on the ``[...]`` link +https://git.yoctoproject.org/cgit.cgi/poky/ and clicking on the ``[...]`` link beneath the "Tag" heading. Some key tags for the ``poky`` repository are ``jethro-14.0.3``, diff --git a/documentation/overview-manual/overview-manual-intro.rst b/documentation/overview-manual/overview-manual-intro.rst index cddc176cff..2e96f1e338 100644 --- a/documentation/overview-manual/overview-manual-intro.rst +++ b/documentation/overview-manual/overview-manual-intro.rst @@ -66,8 +66,8 @@ Other Information Because this manual presents information for many different topics, supplemental information is recommended for full comprehension. For -additional introductory information on the Yocto Project, see the `Yocto -Project Website <&YOCTO_HOME_URL;>`__. If you want to build an image +additional introductory information on the Yocto Project, see the +:yocto_home:`Yocto Project Website <>`. If you want to build an image with no knowledge of Yocto Project as a way of quickly testing it out, see the `Yocto Project Quick Build <&YOCTO_DOCS_BRIEF_URL;>`__ document. For a comprehensive list of links and other documentation, see the diff --git a/documentation/overview-manual/overview-manual-yp-intro.rst b/documentation/overview-manual/overview-manual-yp-intro.rst index 3f98fa939c..743353547e 100644 --- a/documentation/overview-manual/overview-manual-yp-intro.rst +++ b/documentation/overview-manual/overview-manual-yp-intro.rst @@ -47,8 +47,8 @@ Project: system, software, and service vendors exist whose products and services adopt and support the Yocto Project. For a look at the Yocto Project community and the companies involved with the Yocto Project, - see the "COMMUNITY" and "ECOSYSTEM" tabs on the `Yocto - Project <&YOCTO_HOME_URL;>`__ home page. + see the "COMMUNITY" and "ECOSYSTEM" tabs on the + :yocto_home:`Yocto Project <>` home page. - *Architecture Agnostic:* Yocto Project supports Intel, ARM, MIPS, AMD, PPC and other architectures. Most ODMs, OSVs, and chip vendors @@ -482,8 +482,7 @@ The following list consists of components associated with the OpenEmbedded-derived systems, which includes the Yocto Project. The Yocto Project and the OpenEmbedded Project both maintain the OpenEmbedded-Core. You can find the OE-Core metadata in the Yocto - Project `Source - Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta>`__. + Project :yocto_git:`Source Repositories `. Historically, the Yocto Project integrated the OE-Core metadata throughout the Yocto Project source repository reference system @@ -543,8 +542,8 @@ targets: applications that you can tailor to a specific, non-desktop platform to enhance usability in constrained environments. - You can find the Matchbox source in the Yocto Project `Source - Repositories <&YOCTO_GIT_URL;>`__. + You can find the Matchbox source in the Yocto Project + :yocto_git:`Source Repositories <>`. - *Opkg* Open PacKaGe management (opkg) is a lightweight package management system based on the itsy package (ipkg) management system. @@ -696,8 +695,8 @@ into a usable binary image. Poky is a combined repository of BitBake, OpenEmbedded-Core (which is found in ``meta``), ``meta-poky``, ``meta-yocto-bsp``, and documentation provided all together and known to work well together. You can view -these items that make up the Poky repository in the `Source -Repositories <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/>`__. +these items that make up the Poky repository in the +:yocto_git:`Source Repositories `. .. note:: diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 3e8127b927..dbd2aaf159 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst @@ -134,10 +134,9 @@ http://proxy.yoyodyne.com:18023/ # If you do not want to use proxy at all, set this to off. #use_proxy = on The Yocto Project also includes a ``meta-poky/conf/site.conf.sample`` file that shows how to configure CVS and Git proxy servers if needed. For more information on setting up -various proxy types and configuring proxy servers, see the "`Working -Behind a Network -Proxy <&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy>`__" Wiki -page. +various proxy types and configuring proxy servers, see the +":yocto_wiki:`Working Behind a Network Proxy `" +Wiki page. **Q:** What’s the difference between target and target\ ``-native``? @@ -332,9 +331,9 @@ redirect requests through proxy servers. .. note:: - You can find more information on the " - Working Behind a Network Proxy - " Wiki page. + You can find more information on the + ":yocto_wiki:`Working Behind a Network Proxy `" + Wiki page. **Q:** Can I get rid of build output so I can start over? diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst index 31959b2845..377932e2cf 100644 --- a/documentation/ref-manual/migration.rst +++ b/documentation/ref-manual/migration.rst @@ -1248,8 +1248,8 @@ The following reference BSPs changes occurred: The previous reference BSPs for the ``beagleboard`` and ``routerstationpro`` machines are still available in a new -``meta-yocto-bsp-old`` layer in the `Source -Repositories <&YOCTO_GIT_URL;>`__ at +``meta-yocto-bsp-old`` layer in the +:yocto_git:`Source Repositories <>` at http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/. Moving to the Yocto Project 1.7 Release diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst index 4b4f3bac5a..ae5f0e40d1 100644 --- a/documentation/ref-manual/ref-classes.rst +++ b/documentation/ref-manual/ref-classes.rst @@ -2749,7 +2749,7 @@ To use this class, you need to define a number of variables: These variables list alternative commands needed by a package, provide pathnames for links, default links for targets, and so forth. For details on how to use this class, see the comments in the -```update-alternatives.bbclass`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass>`__ +:yocto_git:`update-alternatives.bbclass ` file. .. note:: diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst index 4eba5cdf16..0e26e57155 100644 --- a/documentation/ref-manual/ref-images.rst +++ b/documentation/ref-manual/ref-images.rst @@ -40,8 +40,8 @@ Following is a list of supported recipes: Player `__ or `VMware Workstation `__. - For more information on this image, see the `Build - Appliance <&YOCTO_HOME_URL;/software-item/build-appliance/>`__ page + For more information on this image, see the :yocto_home:`Build + 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-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst index 3144d303f8..a9a937b661 100644 --- a/documentation/ref-manual/ref-system-requirements.rst +++ b/documentation/ref-manual/ref-system-requirements.rst @@ -13,8 +13,8 @@ Rather, use this manual to find variable definitions, class descriptions, and so forth as needed during the course of using the Yocto Project. -For introductory information on the Yocto Project, see the `Yocto -Project Website <&YOCTO_HOME_URL;>`__ and the "`Yocto Project +For introductory information on the Yocto Project, see the +:yocto_home:`Yocto Project Website <>` and the "`Yocto Project Development Environment <&YOCTO_DOCS_OM_URL;#overview-development-environment>`__" chapter in the Yocto Project Overview and Concepts Manual. @@ -68,8 +68,8 @@ distributions: - If you encounter problems, please go to `Yocto Project Bugzilla <&YOCTO_BUGZILLA_URL;>`__ and submit a bug. We are interested in hearing about your experience. For information on - how to submit a bug, see the Yocto Project `Bugzilla wiki - page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__ + how to submit a bug, see the Yocto Project + :yocto_wiki:`Bugzilla wiki page ` and the "`Submitting a Defect Against the Yocto Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" section in the Yocto Project Development Tasks Manual. @@ -255,7 +255,7 @@ installer and automatically installs the tools for you: 1. Execute the ``install-buildtools`` script. Here is an example: $ cd poky $ scripts/install-buildtools --without-extended-buildtools \\ - --base-url YOCTO_DL_URL/releases/yocto \\ --release yocto-DISTRO \\ + --base-url https://downloads.yoctoproject.org/releases/yocto \\ --release yocto-DISTRO \\ --installer-version DISTRO During execution, the buildtools tarball will be downloaded, the diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst index 4bcd0a2d00..f56f7a993f 100644 --- a/documentation/ref-manual/ref-tasks.rst +++ b/documentation/ref-manual/ref-tasks.rst @@ -310,7 +310,7 @@ to locate and apply patch files to the source code. Patch files, by default, are ``*.patch`` and ``*.diff`` files created and kept in a subdirectory of the directory holding the recipe file. For example, consider the -```bluez5`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5>`__ +:yocto_git:`bluez5 ` recipe from the OE-Core layer (i.e. ``poky/meta``): poky/meta/recipes-connectivity/bluez5 This recipe has two patch files located here: poky/meta/recipes-connectivity/bluez5/bluez5 diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst index eacc49fc3d..ec9f6d3948 100644 --- a/documentation/ref-manual/ref-terms.rst +++ b/documentation/ref-manual/ref-terms.rst @@ -213,7 +213,7 @@ universal, the list includes them just in case: In the context of the kernel ("kernel Metadata"), the term refers to the kernel config fragments and features contained in the - ```yocto-kernel-cache`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache>`__ + :yocto_git:`yocto-kernel-cache ` Git repository. OpenEmbedded-Core (OE-Core) @@ -227,8 +227,7 @@ universal, the list includes them just in case: core set of recipes. You can see the Metadata in the ``meta`` directory of the Yocto - Project `Source - Repositories `__. + Project :yocto_git:`Source Repositories <>`. OpenEmbedded Build System The build system specific to the Yocto diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index aa7f59f602..53e99a395a 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst @@ -1853,9 +1853,9 @@ system and gives an overview of their function and contents. process gets source files when working behind a firewall or proxy server, see this specific question in the "`FAQ <#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server>`__" - chapter. You can also refer to the "`Working Behind a Network - Proxy <&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy>`__" Wiki - page. + chapter. You can also refer to the + ":yocto_wiki:`Working Behind a Network Proxy `" + Wiki page. DOC_COMPRESS When inheriting the :ref:`compress_doc ` @@ -3240,7 +3240,7 @@ system and gives an overview of their function and contents. recipe file. See the - ```local.conf.sample.extended`` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>`__ + :yocto_git:`local.conf.sample.extended ` file for additional information. Also, for information on creating an initramfs, see the "`Building an Initial RAM Filesystem (initramfs) Image <&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image>`__" section @@ -3740,8 +3740,8 @@ system and gives an overview of their function and contents. To specify the OE-Core versions for which a layer is compatible, use this variable in your layer's ``conf/layer.conf`` configuration file. - For the list, use the Yocto Project `Release - Name `__ (e.g. + For the list, use the Yocto Project + :yocto_wiki:`Release Name ` (e.g. DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the layer, use a space-separated list: LAYERSERIES_COMPAT_layer_root_name = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE" diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 50f2afae03..b443cbfb79 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -33,7 +33,7 @@ Yocto Project Bugzilla ====================== The Yocto Project uses its own implementation of -`Bugzilla <&YOCTO_BUGZILLA_URL;>`__ to track defects (bugs). +:yocto_bugs:`Bugzilla <>` to track defects (bugs). Implementations of Bugzilla work well for group development because they track bugs and code changes, can be used to communicate changes and problems with developers, can be used to submit and review patches, and @@ -52,11 +52,9 @@ against the Yocto Project, see the following: Project <&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project>`__" section in the Yocto Project Development Tasks Manual. -- The Yocto Project `Bugzilla wiki - page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__ +- The Yocto Project :yocto_wiki:`Bugzilla wiki page ` -For information on Bugzilla in general, see -` `__. +For information on Bugzilla in general, see http://www.bugzilla.org/about/. .. _resources-mailinglist: @@ -109,11 +107,10 @@ Links and Related Documentation Here is a list of resources you might find helpful: -- `The Yocto Project website <&YOCTO_HOME_URL;>`__\ *:* The home site +- :yocto_home:`The Yocto Project Website <>`\ *:* The home site for the Yocto Project. -- `The Yocto Project Main Wiki - Page <&YOCTO_WIKI_URL;/wiki/Main_Page>`__\ *:* The main wiki page for +- :yocto_wiki:`The Yocto Project Main Wiki Page `\ *:* The main wiki page for the Yocto Project. This page contains information about project planning, release engineering, QA & automation, a reference site map, and other resources related to the Yocto Project. @@ -182,12 +179,12 @@ Here is a list of resources you might find helpful: the :term:`OpenEmbedded Build System`, which uses BitBake, that reports build information. -- `FAQ <&YOCTO_WIKI_URL;/wiki/FAQ>`__\ *:* A list of commonly asked +- :yocto_wiki:`FAQ `\ *:* A list of commonly asked questions and their answers. - *Release Notes:* Features, updates and known issues for the current release of the Yocto Project. To access the Release Notes, go to the - `Downloads <&YOCTO_HOME_URL;/software-overview/downloads/>`__ page on + :yocto_home:`Downloads ` page on the Yocto Project website and click on the "RELEASE INFORMATION" link for the appropriate release. @@ -195,8 +192,7 @@ Here is a list of resources you might find helpful: the Yocto Project uses. If you find problems with the Yocto Project, you should report them using this application. -- `Bugzilla Configuration and Bug Tracking Wiki - Page <&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking>`__\ *:* +- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page `\ *:* Information on how to get set up and use the Yocto Project implementation of Bugzilla for logging and tracking Yocto Project defects. diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst index d6d534ea93..ed460c78ea 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.rst +++ b/documentation/sdk-manual/sdk-appendix-obtain.rst @@ -175,8 +175,8 @@ Follow these steps to extract the root filesystem: 1. *Locate and Download the Tarball for the Pre-Built 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 `Index of - Releases <&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/machines/>`__ + in machine-specific folders in the + :yocto_dl:`Index of Releases ` in the "machines" directory. The machine-specific folders of the "machines" directory contain diff --git a/documentation/test-manual/test-manual-intro.rst b/documentation/test-manual/test-manual-intro.rst index 3a40a0ad59..dc8de45fa8 100644 --- a/documentation/test-manual/test-manual-intro.rst +++ b/documentation/test-manual/test-manual-intro.rst @@ -150,7 +150,7 @@ thefollowing types of tests: "`Testing Packages With ptest <&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest>`__" section in the Yocto Project Development Tasks Manual and the - "`Ptest <&YOCTO_WIKI_URL;/wiki/Ptest>`__" Wiki page for more + ":yocto_wiki:`Ptest `" Wiki page for more information on Ptest. - *SDK Testing:* Image tests initiated through the following command: $ diff --git a/documentation/toaster-manual/toaster-manual-reference.rst b/documentation/toaster-manual/toaster-manual-reference.rst index d799b4b99b..0494f55d9e 100644 --- a/documentation/toaster-manual/toaster-manual-reference.rst +++ b/documentation/toaster-manual/toaster-manual-reference.rst @@ -160,14 +160,14 @@ As shipped, Toaster is configured to work with the following releases: - *Yocto Project DISTRO "DISTRO_NAME" or OpenEmbedded "DISTRO_NAME":* This release causes your Toaster projects to build against the head of the DISTRO_NAME_NO_CAP branch at - ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/?h=rocko>`__ or - ` `__. + https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=rocko or + http://git.openembedded.org/openembedded-core/commit/?h=rocko. - *Yocto Project "Master" or OpenEmbedded "Master":* This release causes your Toaster Projects to build against the head of the master branch, which is where active development takes place, at - ` <&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/log/>`__ or - ` `__. + https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or + http://git.openembedded.org/openembedded-core/log/. - *Local Yocto Project or Local OpenEmbedded:* This release causes your Toaster Projects to build against the head of the ``poky`` or -- cgit v1.2.3-54-g00ecf