1
0
mirror of https://git.yoctoproject.org/poky synced 2026-06-04 14:09:47 +00:00

sphinx: fix links when the link text should be displayed

When an hyperlink should be display in the output, there is no need to
any specific syntax or marker, the parser finds links and mail
addresses in ordinary text. Somehow the conversion from pandoc
generated wrong output in the form: ` <link>`__. This patch is
generated using the following Python regexp:

    line = re.sub("` <(https?://.*)>`__",
                  "\\1",
                  line)

(From yocto-docs rev: a35d735a74425dff34c63c086947624467658c40)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Nicolas Dechesne
2020-07-30 13:37:11 +02:00
committed by Richard Purdie
parent 283ed72d48
commit 28afbf81ec
22 changed files with 70 additions and 70 deletions
+5 -5
View File
@@ -107,18 +107,18 @@ tools are common development tools for the Linux platform.
- *PowerTOP:* Helps you determine what software is using the most - *PowerTOP:* Helps you determine what software is using the most
power. You can find out more about PowerTOP at power. You can find out more about PowerTOP at
` <https://01.org/powertop/>`__. https://01.org/powertop/.
- *OProfile:* A system-wide profiler for Linux systems that is capable - *OProfile:* A system-wide profiler for Linux systems that is capable
of profiling all running code at low overhead. You can find out more of profiling all running code at low overhead. You can find out more
about OProfile at ` <http://oprofile.sourceforge.net/about/>`__. For about OProfile at http://oprofile.sourceforge.net/about/. For
examples on how to setup and use this tool, see the examples on how to setup and use this tool, see the
"`OProfile <&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile>`__" "`OProfile <&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile>`__"
section in the Yocto Project Profiling and Tracing Manual. section in the Yocto Project Profiling and Tracing Manual.
- *Perf:* Performance counters for Linux used to keep track of certain - *Perf:* Performance counters for Linux used to keep track of certain
types of hardware and software events. For more information on these types of hardware and software events. For more information on these
types of counters see ` <https://perf.wiki.kernel.org/>`__. For types of counters see https://perf.wiki.kernel.org/. For
examples on how to setup and use this tool, see the examples on how to setup and use this tool, see the
"`perf <&YOCTO_DOCS_PROF_URL;#profile-manual-perf>`__" section in the "`perf <&YOCTO_DOCS_PROF_URL;#profile-manual-perf>`__" section in the
Yocto Project Profiling and Tracing Manual. Yocto Project Profiling and Tracing Manual.
@@ -127,12 +127,12 @@ tools are common development tools for the Linux platform.
information gathering about a running Linux system. This information information gathering about a running Linux system. This information
helps you diagnose performance or functional problems. SystemTap is helps you diagnose performance or functional problems. SystemTap is
not available as a user-space tool through the Eclipse IDE Yocto not available as a user-space tool through the Eclipse IDE Yocto
Plug-in. See ` <http://sourceware.org/systemtap>`__ for more Plug-in. See http://sourceware.org/systemtap for more
information on SystemTap. For examples on how to setup and use this information on SystemTap. For examples on how to setup and use this
tool, see the tool, see the
"`SystemTap <&YOCTO_DOCS_PROF_URL;#profile-manual-systemtap>`__" "`SystemTap <&YOCTO_DOCS_PROF_URL;#profile-manual-systemtap>`__"
section in the Yocto Project Profiling and Tracing Manual. section in the Yocto Project Profiling and Tracing Manual.
- *Lttng-ust:* A User-space Tracer designed to provide detailed - *Lttng-ust:* A User-space Tracer designed to provide detailed
information on user-space activity. See ` <http://lttng.org/ust>`__ information on user-space activity. See http://lttng.org/ust
for more information on Lttng-ust. for more information on Lttng-ust.
+3 -3
View File
@@ -20,19 +20,19 @@ using three different Package Management Systems (PMS):
- *OPKG:* A less well known PMS whose use originated in the - *OPKG:* A less well known PMS whose use originated in the
OpenEmbedded and OpenWrt embedded Linux projects. This PMS works with OpenEmbedded and OpenWrt embedded Linux projects. This PMS works with
files packaged in an ``.ipk`` format. See files packaged in an ``.ipk`` format. See
` <http://en.wikipedia.org/wiki/Opkg>`__ for more information about http://en.wikipedia.org/wiki/Opkg for more information about
OPKG. OPKG.
- *RPM:* A more widely known PMS intended for GNU/Linux distributions. - *RPM:* A more widely known PMS intended for GNU/Linux distributions.
This PMS works with files packaged in an ``.rpm`` format. The build This PMS works with files packaged in an ``.rpm`` format. The build
system currently installs through this PMS by default. See system currently installs through this PMS by default. See
` <http://en.wikipedia.org/wiki/RPM_Package_Manager>`__ for more http://en.wikipedia.org/wiki/RPM_Package_Manager for more
information about RPM. information about RPM.
- *Debian:* The PMS for Debian-based systems is built on many PMS - *Debian:* The PMS for Debian-based systems is built on many PMS
tools. The lower-level PMS tool ``dpkg`` forms the base of the Debian tools. The lower-level PMS tool ``dpkg`` forms the base of the Debian
PMS. For information on dpkg see PMS. For information on dpkg see
` <http://en.wikipedia.org/wiki/Dpkg>`__. http://en.wikipedia.org/wiki/Dpkg.
Configuring the PMS Configuring the PMS
=================== ===================
+2 -2
View File
@@ -137,7 +137,7 @@ comments in the ``adt-installer.conf`` file:
set up your own IPKG repository pointed to by ``YOCTOADT_REPO``, you set up your own IPKG repository pointed to by ``YOCTOADT_REPO``, you
need to be sure that the directory structure follows the same layout need to be sure that the directory structure follows the same layout
as the reference directory set up at as the reference directory set up at
` <http://adtrepo.yoctoproject.org>`__. Also, your repository needs http://adtrepo.yoctoproject.org. Also, your repository needs
to be accessible through HTTP. to be accessible through HTTP.
- ``YOCTOADT_TARGETS``: The machine target architectures for which you - ``YOCTOADT_TARGETS``: The machine target architectures for which you
@@ -572,7 +572,7 @@ follows:
A good example of an external toolchain used with the Yocto Project is A good example of an external toolchain used with the Yocto Project is
Mentor Graphics Sourcery G++ Toolchain. You can see information on how Mentor Graphics Sourcery G++ Toolchain. You can see information on how
to use that particular layer in the ``README`` file at to use that particular layer in the ``README`` file at
` <http://github.com/MentorEmbedded/meta-sourcery/>`__. You can find http://github.com/MentorEmbedded/meta-sourcery/. You can find
further information by reading about the further information by reading about the
:term:`TCMODE` variable in the Yocto :term:`TCMODE` variable in the Yocto
Project Reference Manual's variable glossary. Project Reference Manual's variable glossary.
@@ -261,7 +261,7 @@ Follow these steps to add a hardware layer:
``local.conf`` file specifies the machine for the build. For this ``local.conf`` file specifies the machine for the build. For this
example, set the ``MACHINE`` variable to "cyclone5". These example, set the ``MACHINE`` variable to "cyclone5". These
configurations are used: configurations are used:
` <https://github.com/kraj/meta-altera/blob/master/conf/machine/cyclone5.conf>`__. https://github.com/kraj/meta-altera/blob/master/conf/machine/cyclone5.conf.
.. note:: .. note::
+3 -3
View File
@@ -108,7 +108,7 @@ Some layers function as a layer to hold other BSP layers. These layers
are knows as "`container are knows as "`container
layers <&YOCTO_DOCS_REF_URL;#term-container-layer>`__". An example of layers <&YOCTO_DOCS_REF_URL;#term-container-layer>`__". An example of
this type of layer is OpenEmbedded's this type of layer is OpenEmbedded's
```meta-openembedded`` <https://github.com/openembedded/meta-openembedded>`__ ```meta-openembedded`https://github.com/openembedded/meta-openembedded
layer. The ``meta-openembedded`` layer contains many ``meta-*`` layers. layer. The ``meta-openembedded`` layer contains many ``meta-*`` layers.
In cases like this, you need to include the names of the actual layers In cases like this, you need to include the names of the actual layers
you want to work with, such as: BBLAYERS ?= " \\ you want to work with, such as: BBLAYERS ?= " \\
@@ -164,7 +164,7 @@ section.
4. *Optionally Clone the ``meta-intel`` BSP Layer:* If your hardware is 4. *Optionally Clone the ``meta-intel`` BSP Layer:* If your hardware is
based on current Intel CPUs and devices, you can leverage this BSP based on current Intel CPUs and devices, you can leverage this BSP
layer. For details on the ``meta-intel`` BSP layer, see the layer's layer. For details on the ``meta-intel`` BSP layer, see the layer's
```README`` <http://git.yoctoproject.org/cgit/cgit.cgi/meta-intel/tree/README>`__ ```README`http://git.yoctoproject.org/cgit/cgit.cgi/meta-intel/tree/README
file. file.
1. *Navigate to Your Source Directory:* Typically, you set up the 1. *Navigate to Your Source Directory:* Typically, you set up the
@@ -849,7 +849,7 @@ Yocto Project:
in ``poky/meta`` directory of the :term:`Source Directory` in ``poky/meta`` directory of the :term:`Source Directory`
or in the or in the
OpenEmbedded-Core Layer (``openembedded-core``) at OpenEmbedded-Core Layer (``openembedded-core``) at
` <http://git.openembedded.org/openembedded-core/tree/meta>`__. http://git.openembedded.org/openembedded-core/tree/meta.
You should place recipes (``*.bb`` files) and recipe modifications You should place recipes (``*.bb`` files) and recipe modifications
(``*.bbappend`` files) into ``recipes-*`` subdirectories by (``*.bbappend`` files) into ``recipes-*`` subdirectories by
@@ -294,7 +294,7 @@ Logo for your layer and application. The process consists of two parts:
successful compatibility registration. successful compatibility registration.
2. Completion of an application acceptance form, which you can find at 2. Completion of an application acceptance form, which you can find at
` <https://www.yoctoproject.org/webform/yocto-project-compatible-registration>`__. https://www.yoctoproject.org/webform/yocto-project-compatible-registration.
To be granted permission to use the logo, you need to satisfy the To be granted permission to use the logo, you need to satisfy the
following: following:
@@ -318,7 +318,7 @@ application, you can use the Yocto Project Compatibility Logo with your
layer and the application that uses your layer. layer and the application that uses your layer.
To access the form, use this link: To access the form, use this link:
` <https://www.yoctoproject.org/webform/yocto-project-compatible-registration>`__. https://www.yoctoproject.org/webform/yocto-project-compatible-registration.
Follow the instructions on the form to complete your application. Follow the instructions on the form to complete your application.
The application consists of the following sections: The application consists of the following sections:
@@ -1713,7 +1713,7 @@ the software being built:
install the built software into the directories. install the built software into the directories.
You can find more information on ``install`` at You can find more information on ``install`` at
` <http://www.gnu.org/software/coreutils/manual/html_node/install-invocation.html>`__. http://www.gnu.org/software/coreutils/manual/html_node/install-invocation.html.
For the scenarios that do not use Autotools or CMake, you need to track For the scenarios that do not use Autotools or CMake, you need to track
the installation and diagnose and fix any issues until everything the installation and diagnose and fix any issues until everything
@@ -1796,7 +1796,7 @@ different ways:
- *systemd:* System Management Daemon (systemd) was designed to replace - *systemd:* System Management Daemon (systemd) was designed to replace
SysVinit and to provide enhanced management of services. For more SysVinit and to provide enhanced management of services. For more
information on systemd, see the systemd homepage at information on systemd, see the systemd homepage at
` <http://freedesktop.org/wiki/Software/systemd/>`__. http://freedesktop.org/wiki/Software/systemd/.
To enable a service using systemd, your recipe needs to inherit the To enable a service using systemd, your recipe needs to inherit the
:ref:`systemd <ref-classes-systemd>` class. See :ref:`systemd <ref-classes-systemd>` class. See
@@ -1952,7 +1952,7 @@ recipe, but which one? You can configure your build to call out the
kernel recipe you want by using the kernel recipe you want by using the
:term:`PREFERRED_PROVIDER` :term:`PREFERRED_PROVIDER`
variable. As an example, consider the variable. As an example, consider the
```x86-base.inc`` <https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc>`__ ```x86-base.inc`https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/machine/include/x86-base.inc
include file, which is a machine (i.e. include file, which is a machine (i.e.
:term:`MACHINE`) configuration file. :term:`MACHINE`) configuration file.
This include file is the reason all x86-based machines use the This include file is the reason all x86-based machines use the
@@ -2806,7 +2806,7 @@ the layer tree.
You can easily set up to run the AUH utility on a regular basis by using You can easily set up to run the AUH utility on a regular basis by using
a cron job. See the a cron job. See the
```weeklyjob.sh`` <http://git.yoctoproject.org/cgit/cgit.cgi/auto-upgrade-helper/tree/weeklyjob.sh>`__ ```weeklyjob.sh`http://git.yoctoproject.org/cgit/cgit.cgi/auto-upgrade-helper/tree/weeklyjob.sh
file distributed with the utility for an example. file distributed with the utility for an example.
.. _gs-using-devtool-upgrade: .. _gs-using-devtool-upgrade:
@@ -4764,7 +4764,7 @@ follows:
A good example of an external toolchain used with the Yocto Project is A good example of an external toolchain used with the Yocto Project is
Mentor Graphics Sourcery G++ Toolchain. You can see information on how Mentor Graphics Sourcery G++ Toolchain. You can see information on how
to use that particular layer in the ``README`` file at to use that particular layer in the ``README`` file at
` <http://github.com/MentorEmbedded/meta-sourcery/>`__. You can find http://github.com/MentorEmbedded/meta-sourcery/. You can find
further information by reading about the further information by reading about the
:term:`TCMODE` variable in the Yocto :term:`TCMODE` variable in the Yocto
Project Reference Manual's variable glossary. Project Reference Manual's variable glossary.
@@ -5583,7 +5583,7 @@ system to make your images more secure:
- Consider enabling a Mandatory Access Control (MAC) framework such as - Consider enabling a Mandatory Access Control (MAC) framework such as
SMACK or SELinux and tuning it appropriately for your device's usage. SMACK or SELinux and tuning it appropriately for your device's usage.
You can find more information in the You can find more information in the
```meta-selinux`` <http://git.yoctoproject.org/cgit/cgit.cgi/meta-selinux/>`__ ```meta-selinux`http://git.yoctoproject.org/cgit/cgit.cgi/meta-selinux/
layer. layer.
Tools for Hardening Your Image Tools for Hardening Your Image
@@ -6690,7 +6690,7 @@ NPM packages:
packages, the registry approach is slightly simpler. However, you packages, the registry approach is slightly simpler. However, you
might consider the project approach because you do not have to might consider the project approach because you do not have to
publish your module in the NPM registry publish your module in the NPM registry
(```npm-registry`` <https://docs.npmjs.com/misc/registry>`__), which (```npm-registry`https://docs.npmjs.com/misc/registry), which
is NPM's public registry. is NPM's public registry.
- Be familiar with - Be familiar with
@@ -6698,7 +6698,7 @@ NPM packages:
- The NPM host tools need the native ``nodejs-npm`` package, which is - The NPM host tools need the native ``nodejs-npm`` package, which is
part of the OpenEmbedded environment. You need to get the package by part of the OpenEmbedded environment. You need to get the package by
cloning the ` <https://github.com/openembedded/meta-openembedded>`__ cloning the https://github.com/openembedded/meta-openembedded
repository out of GitHub. Be sure to add the path to your local copy repository out of GitHub. Be sure to add the path to your local copy
to your ``bblayers.conf`` file. to your ``bblayers.conf`` file.
@@ -7547,7 +7547,7 @@ packages/qemux86_64-poky-linux/v86d/v86d: PKGSIZE changed from 110579 to
To see changes to the build history using a web interface, follow the To see changes to the build history using a web interface, follow the
instruction in the ``README`` file here. instruction in the ``README`` file here.
` <http://git.yoctoproject.org/cgit/cgit.cgi/buildhistory-web/>`__. http://git.yoctoproject.org/cgit/cgit.cgi/buildhistory-web/.
Here is a sample screenshot of the interface: Here is a sample screenshot of the interface:
@@ -8945,7 +8945,7 @@ style analysis of program crashes. GDB is available as a package within
the Yocto Project and is installed in SDK images by default. See the the Yocto Project and is installed in SDK images by default. See the
":ref:`ref-manual/ref-images:Images`" chapter in the Yocto ":ref:`ref-manual/ref-images:Images`" chapter in the Yocto
Project Reference Manual for a description of these images. You can find Project Reference Manual for a description of these images. You can find
information on GDB at ` <http://sourceware.org/gdb/>`__. information on GDB at http://sourceware.org/gdb/.
.. note:: .. note::
@@ -10086,7 +10086,7 @@ The server receives the information collected and saves it in a
database. database.
A live instance of the error reporting server exists at A live instance of the error reporting server exists at
` <http://errors.yoctoproject.org>`__. This server exists so that when http://errors.yoctoproject.org. This server exists so that when
you want to get help with build failures, you can submit all of the you want to get help with build failures, you can submit all of the
information on the failure easily and then point to the URL in your bug information on the failure easily and then point to the URL in your bug
report or send an email to the mailing list. report or send an email to the mailing list.
@@ -10119,7 +10119,7 @@ following command sends the errors to an upstream server: $
send-error-report send-error-report
/home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt /home/brandusa/project/poky/build/tmp/log/error-report/error_report_201403141617.txt
In the previous example, the errors are sent to a public database In the previous example, the errors are sent to a public database
available at ` <http://errors.yoctoproject.org>`__, which is used by the available at http://errors.yoctoproject.org, which is used by the
entire community. If you specify a particular server, you can send the entire community. If you specify a particular server, you can send the
errors to a different database. Use the following command for more errors to a different database. Use the following command for more
information on available options: $ send-error-report --help information on available options: $ send-error-report --help
@@ -10145,7 +10145,7 @@ Setting Up Your Own Error Reporting Server
If you want to set up your own error reporting server, you can obtain If you want to set up your own error reporting server, you can obtain
the code from the Git repository at the code from the Git repository at
` <http://git.yoctoproject.org/cgit/cgit.cgi/error-report-web/>`__. http://git.yoctoproject.org/cgit/cgit.cgi/error-report-web/.
Instructions on how to set it up are in the README document. Instructions on how to set it up are in the README document.
.. _dev-using-wayland-and-weston: .. _dev-using-wayland-and-weston:
@@ -445,14 +445,14 @@ as your Yocto Project build host:
5. *Optionally Orient Yourself With Docker:* If you are unfamiliar with 5. *Optionally Orient Yourself With Docker:* If you are unfamiliar with
Docker and the container concept, you can learn more here - Docker and the container concept, you can learn more here -
` <https://docs.docker.com/get-started/>`__. https://docs.docker.com/get-started/.
6. *Launch Docker or Docker Toolbox:* You should be able to launch 6. *Launch Docker or Docker Toolbox:* You should be able to launch
Docker or the Docker Toolbox and have a terminal shell on your Docker or the Docker Toolbox and have a terminal shell on your
development host. development host.
7. *Set Up the Containers to Use the Yocto Project:* Go to 7. *Set Up the Containers to Use the Yocto Project:* Go to
` <https://github.com/crops/docker-win-mac-docs/wiki>`__ and follow https://github.com/crops/docker-win-mac-docs/wiki and follow
the directions for your particular build host (i.e. Linux, Mac, or the directions for your particular build host (i.e. Linux, Mac, or
Windows). Windows).
@@ -514,7 +514,7 @@ your Yocto Project build host:
4. *Optionally Orient Yourself on WSL:* If you are unfamiliar with WSL, 4. *Optionally Orient Yourself on WSL:* If you are unfamiliar with WSL,
you can learn more here - you can learn more here -
` <https://docs.microsoft.com/en-us/windows/wsl/wsl2-about>`__. https://docs.microsoft.com/en-us/windows/wsl/wsl2-about.
5. *Launch your WSL Distibution:* From the Windows start menu simply 5. *Launch your WSL Distibution:* From the Windows start menu simply
launch your WSL distribution just like any other application. launch your WSL distribution just like any other application.
@@ -960,7 +960,7 @@ Using  ``menuconfig``
The easiest way to define kernel configurations is to set them through The easiest way to define kernel configurations is to set them through
the ``menuconfig`` tool. This tool provides an interactive method with the ``menuconfig`` tool. This tool provides an interactive method with
which to set kernel configurations. For general information on which to set kernel configurations. For general information on
``menuconfig``, see ` <http://en.wikipedia.org/wiki/Menuconfig>`__. ``menuconfig``, see http://en.wikipedia.org/wiki/Menuconfig.
To use the ``menuconfig`` tool in the Yocto Project development To use the ``menuconfig`` tool in the Yocto Project development
environment, you must do the following: environment, you must do the following:
@@ -11,7 +11,7 @@ Yocto Project Kernel Development and Maintenance
Kernels available through the Yocto Project (Yocto Linux kernels), like Kernels available through the Yocto Project (Yocto Linux kernels), like
other kernels, are based off the Linux kernel releases from other kernels, are based off the Linux kernel releases from
` <http://www.kernel.org>`__. At the beginning of a major Linux kernel http://www.kernel.org. At the beginning of a major Linux kernel
development cycle, the Yocto Project team chooses a Linux kernel based development cycle, the Yocto Project team chooses a Linux kernel based
on factors such as release timing, the anticipated release timing of on factors such as release timing, the anticipated release timing of
final upstream ``kernel.org`` versions, and Yocto Project feature final upstream ``kernel.org`` versions, and Yocto Project feature
@@ -162,7 +162,7 @@ implemented by the Yocto Project team using the Source Code Manager
different work flows, front-ends and management techniques. different work flows, front-ends and management techniques.
- You can find documentation on Git at - You can find documentation on Git at
` <http://git-scm.com/documentation>`__. You can also get an http://git-scm.com/documentation. You can also get an
introduction to Git as it applies to the Yocto Project in the introduction to Git as it applies to the Yocto Project in the
"`Git <&YOCTO_DOCS_OM_URL;#git>`__" section in the Yocto Project "`Git <&YOCTO_DOCS_OM_URL;#git>`__" section in the Yocto Project
Overview and Concepts Manual. The latter reference provides an Overview and Concepts Manual. The latter reference provides an
@@ -385,7 +385,7 @@ figure <#general-workflow-figure>`__:
- *Metadata (``.bb`` + Patches):* Software layers containing - *Metadata (``.bb`` + Patches):* Software layers containing
user-supplied recipe files, patches, and append files. A good example user-supplied recipe files, patches, and append files. A good example
of a software layer might be the of a software layer might be the
```meta-qt5`` <https://github.com/meta-qt5/meta-qt5>`__ layer from ```meta-qt5`https://github.com/meta-qt5/meta-qt5 layer from
the `OpenEmbedded Layer the `OpenEmbedded Layer
Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__. Index <http://layers.openembedded.org/layerindex/branch/master/layers/>`__.
This layer is for version 5.0 of the popular This layer is for version 5.0 of the popular
@@ -381,12 +381,12 @@ commands.
.. note:: .. note::
- For more information on Git, see - For more information on Git, see
` <http://git-scm.com/documentation>`__. http://git-scm.com/documentation.
- If you need to download Git, it is recommended that you add Git to - If you need to download Git, it is recommended that you add Git to
your system through your distribution's "software store" (e.g. for your system through your distribution's "software store" (e.g. for
Ubuntu, use the Ubuntu Software feature). For the Git download Ubuntu, use the Ubuntu Software feature). For the Git download
page, see ` <http://git-scm.com/download>`__. page, see http://git-scm.com/download.
- For information beyond the introductory nature in this section, - For information beyond the introductory nature in this section,
see the "`Locating Yocto Project Source see the "`Locating Yocto Project Source
+1 -1
View File
@@ -263,7 +263,7 @@ OpenEmbedded build system to use its internally built toolchain (i.e.
particular, "external-*" refers to external toolchains. One example is particular, "external-*" refers to external toolchains. One example is
the Sourcery G++ Toolchain. The support for this toolchain resides in the Sourcery G++ Toolchain. The support for this toolchain resides in
the separate ``meta-sourcery`` layer at the separate ``meta-sourcery`` layer at
` <http://github.com/MentorEmbedded/meta-sourcery/>`__. http://github.com/MentorEmbedded/meta-sourcery/.
In addition to the toolchain configuration, you also need a In addition to the toolchain configuration, you also need a
corresponding toolchain recipe file. This recipe file needs to package corresponding toolchain recipe file. This recipe file needs to package
+8 -8
View File
@@ -836,7 +836,7 @@ Following is a list of short entries describing other changes:
- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict - ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict
with ``multilib``. See with ``multilib``. See
```YOCTO #4993`` <https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993>`__ ```YOCTO #4993`https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993
in Bugzilla for more information. in Bugzilla for more information.
- ``linux-dtb``: Use kernel build system to generate the ``dtb`` files. - ``linux-dtb``: Use kernel build system to generate the ``dtb`` files.
@@ -1658,9 +1658,9 @@ apply this
The standard ``linux-yocto`` kernel source tree already has a workaround The standard ``linux-yocto`` kernel source tree already has a workaround
for the same issue. for the same issue.
For further details, see ` <https://gcc.gnu.org/gcc-5/changes.html>`__ For further details, see https://gcc.gnu.org/gcc-5/changes.html
and the porting guide at and the porting guide at
` <https://gcc.gnu.org/gcc-5/porting_to.html>`__. https://gcc.gnu.org/gcc-5/porting_to.html.
Alternatively, you can switch back to GCC 4.9 or 4.8 by setting Alternatively, you can switch back to GCC 4.9 or 4.8 by setting
``GCCVERSION`` in your configuration, as follows: GCCVERSION = "4.9%" ``GCCVERSION`` in your configuration, as follows: GCCVERSION = "4.9%"
@@ -1991,13 +1991,13 @@ The use of ``${libdir}/${BPN}`` as ``libexecdir`` is different as
compared to all other mainstream distributions, which either uses compared to all other mainstream distributions, which either uses
``${prefix}/libexec`` or ``${libdir}``. The use is also contrary to the ``${prefix}/libexec`` or ``${libdir}``. The use is also contrary to the
GNU Coding Standards (i.e. GNU Coding Standards (i.e.
` <https://www.gnu.org/prep/standards/html_node/Directory-Variables.html>`__) https://www.gnu.org/prep/standards/html_node/Directory-Variables.html)
that suggest ``${prefix}/libexec`` and also notes that any that suggest ``${prefix}/libexec`` and also notes that any
package-specific nesting should be done by the package itself. Finally, package-specific nesting should be done by the package itself. Finally,
having ``libexecdir`` change between recipes makes it very difficult for having ``libexecdir`` change between recipes makes it very difficult for
different recipes to invoke binaries that have been installed into different recipes to invoke binaries that have been installed into
``libexecdir``. The Filesystem Hierarchy Standard (i.e. ``libexecdir``. The Filesystem Hierarchy Standard (i.e.
` <http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html>`__) now http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now
recognizes the use of ``${prefix}/libexec/``, giving distributions the recognizes the use of ``${prefix}/libexec/``, giving distributions the
choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without
breaking FHS. breaking FHS.
@@ -3874,7 +3874,7 @@ GCC 8.2 is Now Used by Default
The GNU Compiler Collection version 8.2 is now used by default for The GNU Compiler Collection version 8.2 is now used by default for
compilation. For more information on what has changed in the GCC 8.x compilation. For more information on what has changed in the GCC 8.x
release, see ` <https://gcc.gnu.org/gcc-8/changes.html>`__. release, see https://gcc.gnu.org/gcc-8/changes.html.
If you still need to compile with version 7.x, GCC 7.3 is also provided. If you still need to compile with version 7.x, GCC 7.3 is also provided.
You can select this version by setting the and can be selected by You can select this version by setting the and can be selected by
@@ -4472,7 +4472,7 @@ The following miscellaneous changes occurred:
from the top-level ``scripts`` directory. from the top-level ``scripts`` directory.
- Perl now builds for the target using - Perl now builds for the target using
```perl-cross`` <http://arsv.github.io/perl-cross/>`__ for better ```perl-cross`http://arsv.github.io/perl-cross/ for better
maintainability and improved build performance. This change should maintainability and improved build performance. This change should
not present any problems unless you have heavily customized your Perl not present any problems unless you have heavily customized your Perl
recipe. recipe.
@@ -4690,7 +4690,7 @@ The following BitBake changes have occurred.
```BB_HASHCHECK_FUNCTION`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_HASHCHECK_FUNCTION>`__ ```BB_HASHCHECK_FUNCTION`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_HASHCHECK_FUNCTION>`__
have changed. If you are using your own custom hash check function, have changed. If you are using your own custom hash check function,
see see
` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725>`__ http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725
for details. for details.
- Task specifications in ``BB_TASKDEPDATA`` and class implementations - Task specifications in ``BB_TASKDEPDATA`` and class implementations
+1 -1
View File
@@ -283,7 +283,7 @@ The ``ccache`` class enables the C/C++ Compiler Cache for the build.
This class is used to give a minor performance boost during the build. This class is used to give a minor performance boost during the build.
However, using the class can lead to unexpected side-effects. Thus, it However, using the class can lead to unexpected side-effects. Thus, it
is recommended that you do not use this class. See is recommended that you do not use this class. See
` <http://ccache.samba.org/>`__ for information on the C/C++ Compiler http://ccache.samba.org/ for information on the C/C++ Compiler
Cache. Cache.
.. _ref-classes-chrpath: .. _ref-classes-chrpath:
@@ -287,7 +287,7 @@ particular recipe.
.. note:: .. note::
- For the ``oe-core`` layer, recipe maintainers come from the - For the ``oe-core`` layer, recipe maintainers come from the
```maintainers.inc`` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc>`__ ```maintainers.inc`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc
file. file.
- If the recipe is using the `Git - If the recipe is using the `Git
+1 -1
View File
@@ -155,7 +155,7 @@ the ``part`` and ``partition`` commands:
- *``--part-type``:* This option is a Wic-specific option that - *``--part-type``:* This option is a Wic-specific option that
specifies the partition type globally unique identifier (GUID) for specifies the partition type globally unique identifier (GUID) for
GPT partitions. You can find the list of partition type GUIDs at GPT partitions. You can find the list of partition type GUIDs at
` <http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs>`__. http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs.
- *``--use-uuid``:* This option is a Wic-specific option that causes - *``--use-uuid``:* This option is a Wic-specific option that causes
Wic to generate a random GUID for the partition. The generated Wic to generate a random GUID for the partition. The generated
+1 -1
View File
@@ -212,7 +212,7 @@ Errors and Warnings
you could add the following to your recipe: CFLAGS_append = " -fPIC " you could add the following to your recipe: CFLAGS_append = " -fPIC "
For more information on text relocations at runtime, see For more information on text relocations at runtime, see
` <http://www.akkadia.org/drepper/textrelocs.html>`__. http://www.akkadia.org/drepper/textrelocs.html.
   
@@ -54,7 +54,7 @@ codename are likely to be compatible and thus work together.
Releases are given a nominal release version as well but the codename is Releases are given a nominal release version as well but the codename is
used in repositories for this reason. You can find information on Yocto used in repositories for this reason. You can find information on Yocto
Project releases and codenames at Project releases and codenames at
` <https://wiki.yoctoproject.org/wiki/Releases>`__. https://wiki.yoctoproject.org/wiki/Releases.
Stable Release Process Stable Release Process
====================== ======================
@@ -84,7 +84,7 @@ Community LTS trees and branches exist where community members share
patches for older releases. However, these types of patches do not go patches for older releases. However, these types of patches do not go
through the same release process as do point releases. You can find more through the same release process as do point releases. You can find more
information about stable branch maintenance at information about stable branch maintenance at
` <https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance>`__. https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance.
Testing and Quality Assurance Testing and Quality Assurance
============================= =============================
+10 -10
View File
@@ -546,7 +546,7 @@ system and gives an overview of their function and contents.
software. software.
When specifying recipe files, you can pattern match using Python's When specifying recipe files, you can pattern match using Python's
```glob`` <https://docs.python.org/3/library/glob.html>`__ syntax. ```glob`https://docs.python.org/3/library/glob.html syntax.
For details on the syntax, see the documentation by following the For details on the syntax, see the documentation by following the
previous link. previous link.
@@ -604,7 +604,7 @@ system and gives an overview of their function and contents.
compiler. Consequently, the syntax follows Python's Regular compiler. Consequently, the syntax follows Python's Regular
Expression (re) syntax. The expressions are compared against the full Expression (re) syntax. The expressions are compared against the full
paths to the files. For complete syntax information, see Python's paths to the files. For complete syntax information, see Python's
documentation at ` <http://docs.python.org/3/library/re.html#re>`__. documentation at http://docs.python.org/3/library/re.html#re.
The following example uses a complete regular expression to tell The following example uses a complete regular expression to tell
BitBake to ignore all recipe and recipe append files in the BitBake to ignore all recipe and recipe append files in the
@@ -2173,7 +2173,7 @@ system and gives an overview of their function and contents.
- When specifying files or paths, you can pattern match using - When specifying files or paths, you can pattern match using
Python's Python's
```glob`` <https://docs.python.org/2/library/glob.html>`__ ```glob`https://docs.python.org/2/library/glob.html
syntax. For details on the syntax, see the documentation by syntax. For details on the syntax, see the documentation by
following the previous link. following the previous link.
@@ -2435,7 +2435,7 @@ system and gives an overview of their function and contents.
Here is an example from the ``dbus`` recipe: GROUPADD_PARAM_${PN} = Here is an example from the ``dbus`` recipe: GROUPADD_PARAM_${PN} =
"-r netdev" For information on the standard Linux shell command "-r netdev" For information on the standard Linux shell command
``groupadd``, see ` <http://linux.die.net/man/8/groupadd>`__. ``groupadd``, see http://linux.die.net/man/8/groupadd.
GROUPMEMS_PARAM GROUPMEMS_PARAM
When inheriting the :ref:`useradd <ref-classes-useradd>` class, When inheriting the :ref:`useradd <ref-classes-useradd>` class,
@@ -2444,7 +2444,7 @@ system and gives an overview of their function and contents.
of a group when the package is installed. of a group when the package is installed.
For information on the standard Linux shell command ``groupmems``, For information on the standard Linux shell command ``groupmems``,
see ` <http://linux.die.net/man/8/groupmems>`__. see http://linux.die.net/man/8/groupmems.
GRUB_GFXSERIAL GRUB_GFXSERIAL
Configures the GNU GRand Unified Bootloader (GRUB) to have graphics Configures the GNU GRand Unified Bootloader (GRUB) to have graphics
@@ -3313,7 +3313,7 @@ system and gives an overview of their function and contents.
The value in ``INITSCRIPT_PARAMS`` is passed through to the The value in ``INITSCRIPT_PARAMS`` is passed through to the
``update-rc.d`` command. For more information on valid parameters, ``update-rc.d`` command. For more information on valid parameters,
please see the ``update-rc.d`` manual page at please see the ``update-rc.d`` manual page at
` <http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d>`__. http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d.
INSANE_SKIP INSANE_SKIP
Specifies the QA checks to skip for a specific package within a Specifies the QA checks to skip for a specific package within a
@@ -4193,7 +4193,7 @@ system and gives an overview of their function and contents.
variable for more information. variable for more information.
module_conf module_conf
Specifies ```modprobe.d`` <http://linux.die.net/man/5/modprobe.d>`__ Specifies ```modprobe.d`http://linux.die.net/man/5/modprobe.d
syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf``
file. file.
@@ -7069,7 +7069,7 @@ system and gives an overview of their function and contents.
toolchain. One example is the Sourcery G++ Toolchain. The support for toolchain. One example is the Sourcery G++ Toolchain. The support for
this toolchain resides in the separate Mentor Graphics this toolchain resides in the separate Mentor Graphics
``meta-sourcery`` layer at ``meta-sourcery`` layer at
` <http://github.com/MentorEmbedded/meta-sourcery/>`__. http://github.com/MentorEmbedded/meta-sourcery/.
The layer's ``README`` file contains information on how to use the The layer's ``README`` file contains information on how to use the
Sourcery G++ Toolchain as an external toolchain. In summary, you must Sourcery G++ Toolchain as an external toolchain. In summary, you must
@@ -7527,7 +7527,7 @@ system and gives an overview of their function and contents.
"sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-boot image. "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-boot image.
For more information on how the ``UBOOT_CONFIG`` is handled, see the For more information on how the ``UBOOT_CONFIG`` is handled, see the
```uboot-config`` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/uboot-config.bbclass>`__ ```uboot-config`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/uboot-config.bbclass
class. class.
UBOOT_ENTRYPOINT UBOOT_ENTRYPOINT
@@ -7787,7 +7787,7 @@ system and gives an overview of their function and contents.
"--system --home ${localstatedir}/lib/dbus \\ --no-create-home "--system --home ${localstatedir}/lib/dbus \\ --no-create-home
--shell /bin/false \\ --user-group messagebus" For information on the --shell /bin/false \\ --user-group messagebus" For information on the
standard Linux shell command ``useradd``, see standard Linux shell command ``useradd``, see
` <http://linux.die.net/man/8/useradd>`__. http://linux.die.net/man/8/useradd.
USERADD_UID_TABLES USERADD_UID_TABLES
Specifies a password file to use for obtaining static user Specifies a password file to use for obtaining static user
@@ -27,7 +27,7 @@ loaded with information from the `README <>`__ files and notes from key
engineers: engineers:
- *``yocto-autobuilder2``:* This - *``yocto-autobuilder2``:* This
```README.md`` <http://git.yoctoproject.org/clean/cgit.cgi/yocto-autobuilder2/tree/README.md>`__ ```README.md`http://git.yoctoproject.org/clean/cgit.cgi/yocto-autobuilder2/tree/README.md
is the main README which detials how to set up the Yocto Project is the main README which detials how to set up the Yocto Project
Autobuilder. The ``yocto-autobuilder2`` repository represents the Autobuilder. The ``yocto-autobuilder2`` repository represents the
Yocto Project's console UI plugin to Buildbot and the configuration Yocto Project's console UI plugin to Buildbot and the configuration
@@ -35,7 +35,7 @@ engineers:
requires. requires.
- *``yocto-autobuilder-helper``:* This - *``yocto-autobuilder-helper``:* This
```README`` <http://git.yoctoproject.org/clean/cgit.cgi/yocto-autobuilder-helper/tree/README>`__ ```README`http://git.yoctoproject.org/clean/cgit.cgi/yocto-autobuilder-helper/tree/README
and repository contains Yocto Project Autobuilder Helper scripts and and repository contains Yocto Project Autobuilder Helper scripts and
configuration. The ``yocto-autobuilder-helper`` repository contains configuration. The ``yocto-autobuilder-helper`` repository contains
the "glue" logic that defines which tests to run and how to run them. the "glue" logic that defines which tests to run and how to run them.
@@ -29,7 +29,7 @@ extensive information about the build process.
- Browse layers listed in the various `layer - Browse layers listed in the various `layer
sources <#layer-source>`__ that are available in your project sources <#layer-source>`__ that are available in your project
(e.g. the OpenEmbedded Layer Index at (e.g. the OpenEmbedded Layer Index at
` <http://layers.openembedded.org/layerindex/>`__). http://layers.openembedded.org/layerindex/).
- Browse images, recipes, and machines provided by those layers. - Browse images, recipes, and machines provided by those layers.
@@ -24,9 +24,9 @@ type of layer source called a "layer index."
A layer index is a web application that contains information about a set A layer index is a web application that contains information about a set
of custom layers. A good example of an existing layer index is the of custom layers. A good example of an existing layer index is the
OpenEmbedded Layer Index. A public instance of this layer index exists OpenEmbedded Layer Index. A public instance of this layer index exists
at ` <http://layers.openembedded.org>`__. You can find the code for this at http://layers.openembedded.org. You can find the code for this
layer index's web application at layer index's web application at
` <http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/>`__. http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/.
When you tie a layer source into Toaster, it can query the layer source When you tie a layer source into Toaster, it can query the layer source
through a through a
@@ -87,9 +87,9 @@ describes two methods by which you can configure and use your layer
index. index.
In the previous section, the code for the OpenEmbedded Metadata Index In the previous section, the code for the OpenEmbedded Metadata Index
(i.e. ` <http://layers.openembedded.org>`__) was referenced. You can use (i.e. http://layers.openembedded.org) was referenced. You can use
this code, which is at this code, which is at
` <http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/>`__, as a http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/, as a
base to create your own layer index. base to create your own layer index.
Use the Administration Interface Use the Administration Interface