diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-11-03 15:59:38 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-11-07 21:31:32 +0000 |
commit | 3a7dd1d36891d76c5160e11b39ad85a3cbd69e68 (patch) | |
tree | 216e3093cc9f3c9dbb035132377efd04485183a3 /documentation | |
parent | ceb169bd59e1efaf1bfc02cd1df24521dbb86290 (diff) | |
download | poky-3a7dd1d36891d76c5160e11b39ad85a3cbd69e68.tar.gz |
manuals: add shortcut for Wikipedia links
(From yocto-docs rev: 47101c15cce156ab71683cac1c42ab94f43bdbee)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/bsp-guide/bsp.rst | 2 | ||||
-rw-r--r-- | documentation/conf.py | 1 | ||||
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 26 | ||||
-rw-r--r-- | documentation/dev-manual/start.rst | 2 | ||||
-rw-r--r-- | documentation/kernel-dev/common.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/migration-3.0.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/migration-4.0.rst | 4 | ||||
-rw-r--r-- | documentation/migration-guides/release-notes-4.0.rst | 4 | ||||
-rw-r--r-- | documentation/overview-manual/concepts.rst | 4 | ||||
-rw-r--r-- | documentation/overview-manual/development-environment.rst | 15 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 6 | ||||
-rw-r--r-- | documentation/ref-manual/features.rst | 22 | ||||
-rw-r--r-- | documentation/ref-manual/kickstart.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/terms.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 6 | ||||
-rw-r--r-- | documentation/sdk-manual/appendix-customizing.rst | 10 | ||||
-rw-r--r-- | documentation/sdk-manual/working-projects.rst | 6 | ||||
-rw-r--r-- | documentation/test-manual/intro.rst | 3 | ||||
-rw-r--r-- | documentation/toaster-manual/reference.rst | 7 |
19 files changed, 58 insertions, 70 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst index efdaf80f63..117056ebd1 100644 --- a/documentation/bsp-guide/bsp.rst +++ b/documentation/bsp-guide/bsp.rst | |||
@@ -1356,7 +1356,7 @@ Project Reference Manual. | |||
1356 | - :term:`EXTRA_IMAGECMD`: | 1356 | - :term:`EXTRA_IMAGECMD`: |
1357 | Specifies additional options for image creation commands. In this | 1357 | Specifies additional options for image creation commands. In this |
1358 | example, the "-lnp " option is used when creating the | 1358 | example, the "-lnp " option is used when creating the |
1359 | `JFFS2 <https://en.wikipedia.org/wiki/JFFS2>`__ image. | 1359 | :wikipedia:`JFFS2 <JFFS2>` image. |
1360 | 1360 | ||
1361 | - :term:`WKS_FILE`: The location of | 1361 | - :term:`WKS_FILE`: The location of |
1362 | the :ref:`Wic kickstart <ref-manual/kickstart:openembedded kickstart (\`\`.wks\`\`) reference>` file used | 1362 | the :ref:`Wic kickstart <ref-manual/kickstart:openembedded kickstart (\`\`.wks\`\`) reference>` file used |
diff --git a/documentation/conf.py b/documentation/conf.py index 07a15ce7de..bd45a73fa6 100644 --- a/documentation/conf.py +++ b/documentation/conf.py | |||
@@ -106,6 +106,7 @@ extlinks = { | |||
106 | 'oe_wiki': ('https://www.openembedded.org/wiki%s', None), | 106 | 'oe_wiki': ('https://www.openembedded.org/wiki%s', None), |
107 | 'oe_layerindex': ('https://layers.openembedded.org%s', None), | 107 | 'oe_layerindex': ('https://layers.openembedded.org%s', None), |
108 | 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None), | 108 | 'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None), |
109 | 'wikipedia': ('https://en.wikipedia.org/wiki/%s', None), | ||
109 | } | 110 | } |
110 | 111 | ||
111 | # Intersphinx config to use cross reference with BitBake user manual | 112 | # Intersphinx config to use cross reference with BitBake user manual |
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 21215d1203..b9c467526a 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -7157,8 +7157,7 @@ system. This section provides information for RPM, IPK, and DEB. | |||
7157 | Using RPM | 7157 | Using RPM |
7158 | ^^^^^^^^^ | 7158 | ^^^^^^^^^ |
7159 | 7159 | ||
7160 | The `Dandified Packaging | 7160 | The :wikipedia:`Dandified Packaging <DNF_(software)>` (DNF) performs |
7161 | Tool <https://en.wikipedia.org/wiki/DNF_(software)>`__ (DNF) performs | ||
7162 | runtime package management of RPM packages. In order to use DNF for | 7161 | runtime package management of RPM packages. In order to use DNF for |
7163 | runtime package management, you must perform an initial setup on the | 7162 | runtime package management, you must perform an initial setup on the |
7164 | target machine for cases where the ``PACKAGE_FEED_*`` variables were not | 7163 | target machine for cases where the ``PACKAGE_FEED_*`` variables were not |
@@ -7501,7 +7500,7 @@ test. Here is what you have to do for each recipe: | |||
7501 | Creating Node Package Manager (NPM) Packages | 7500 | Creating Node Package Manager (NPM) Packages |
7502 | -------------------------------------------- | 7501 | -------------------------------------------- |
7503 | 7502 | ||
7504 | `NPM <https://en.wikipedia.org/wiki/Npm_(software)>`__ is a package | 7503 | :wikipedia:`NPM <Npm_(software)>` is a package |
7505 | manager for the JavaScript programming language. The Yocto Project | 7504 | manager for the JavaScript programming language. The Yocto Project |
7506 | supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can | 7505 | supports the NPM :ref:`fetcher <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`. You can |
7507 | use this fetcher in combination with | 7506 | use this fetcher in combination with |
@@ -9374,8 +9373,7 @@ This command writes the following files in the current directory: | |||
9374 | 9373 | ||
9375 | - ``task-depends.dot``: A graph showing dependencies between tasks. | 9374 | - ``task-depends.dot``: A graph showing dependencies between tasks. |
9376 | 9375 | ||
9377 | The graphs are in | 9376 | The graphs are in :wikipedia:`DOT <DOT_%28graph_description_language%29>` |
9378 | `DOT <https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29>`__ | ||
9379 | format and can be converted to images (e.g. using the ``dot`` tool from | 9377 | format and can be converted to images (e.g. using the ``dot`` tool from |
9380 | `Graphviz <https://www.graphviz.org/>`__). | 9378 | `Graphviz <https://www.graphviz.org/>`__). |
9381 | 9379 | ||
@@ -11435,7 +11433,7 @@ Vulnerabilities in Poky and OE-Core | |||
11435 | 11433 | ||
11436 | The Yocto Project has an infrastructure to track and address unfixed | 11434 | The Yocto Project has an infrastructure to track and address unfixed |
11437 | known security vulnerabilities, as tracked by the public | 11435 | known security vulnerabilities, as tracked by the public |
11438 | `Common Vulnerabilities and Exposures (CVE) <https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures>`__ | 11436 | :wikipedia:`Common Vulnerabilities and Exposures (CVE) <Common_Vulnerabilities_and_Exposures>` |
11439 | database. | 11437 | database. |
11440 | 11438 | ||
11441 | The Yocto Project maintains a `list of known vulnerabilities | 11439 | The Yocto Project maintains a `list of known vulnerabilities |
@@ -11791,7 +11789,7 @@ Instructions on how to set it up are in the README document. | |||
11791 | Using Wayland and Weston | 11789 | Using Wayland and Weston |
11792 | ======================== | 11790 | ======================== |
11793 | 11791 | ||
11794 | `Wayland <https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)>`__ | 11792 | :wikipedia:`Wayland <Wayland_(display_server_protocol)>` |
11795 | is a computer display server protocol that provides a method for | 11793 | is a computer display server protocol that provides a method for |
11796 | compositing window managers to communicate directly with applications | 11794 | compositing window managers to communicate directly with applications |
11797 | and video hardware and expects them to communicate with input hardware | 11795 | and video hardware and expects them to communicate with input hardware |
@@ -11800,20 +11798,18 @@ in better control over graphics frame rendering than an application | |||
11800 | might otherwise achieve. | 11798 | might otherwise achieve. |
11801 | 11799 | ||
11802 | The Yocto Project provides the Wayland protocol libraries and the | 11800 | The Yocto Project provides the Wayland protocol libraries and the |
11803 | reference | 11801 | reference :wikipedia:`Weston <Wayland_(display_server_protocol)#Weston>` |
11804 | `Weston <https://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston>`__ | ||
11805 | compositor as part of its release. You can find the integrated packages | 11802 | compositor as part of its release. You can find the integrated packages |
11806 | in the ``meta`` layer of the :term:`Source Directory`. | 11803 | in the ``meta`` layer of the :term:`Source Directory`. |
11807 | Specifically, you | 11804 | Specifically, you |
11808 | can find the recipes that build both Wayland and Weston at | 11805 | can find the recipes that build both Wayland and Weston at |
11809 | ``meta/recipes-graphics/wayland``. | 11806 | ``meta/recipes-graphics/wayland``. |
11810 | 11807 | ||
11811 | You can build both the Wayland and Weston packages for use only with | 11808 | You can build both the Wayland and Weston packages for use only with targets |
11812 | targets that accept the `Mesa 3D and Direct Rendering | 11809 | that accept the :wikipedia:`Mesa 3D and Direct Rendering Infrastructure |
11813 | Infrastructure <https://en.wikipedia.org/wiki/Mesa_(computer_graphics)>`__, | 11810 | <Mesa_(computer_graphics)>`, which is also known as Mesa DRI. This implies that |
11814 | which is also known as Mesa DRI. This implies that you cannot build and | 11811 | you cannot build and use the packages if your target uses, for example, the |
11815 | use the packages if your target uses, for example, the Intel Embedded | 11812 | Intel Embedded Media and Graphics Driver (Intel EMGD) that overrides Mesa DRI. |
11816 | Media and Graphics Driver (Intel EMGD) that overrides Mesa DRI. | ||
11817 | 11813 | ||
11818 | .. note:: | 11814 | .. note:: |
11819 | 11815 | ||
diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index f90375471f..63d63fc27e 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst | |||
@@ -273,7 +273,7 @@ For Linux (WSL 2). | |||
273 | .. note:: | 273 | .. note:: |
274 | 274 | ||
275 | The Yocto Project is not compatible with version 1 of | 275 | The Yocto Project is not compatible with version 1 of |
276 | `Windows Subsystem for Linux <https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux>`__. | 276 | :wikipedia:`Windows Subsystem for Linux <Windows_Subsystem_for_Linux>`. |
277 | It is compatible but neither officially supported nor validated with | 277 | It is compatible but neither officially supported nor validated with |
278 | WSL 2. If you still decide to use WSL please upgrade to | 278 | WSL 2. If you still decide to use WSL please upgrade to |
279 | `WSL 2 <https://learn.microsoft.com/en-us/windows/wsl/install>`__. | 279 | `WSL 2 <https://learn.microsoft.com/en-us/windows/wsl/install>`__. |
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst index 690f61110b..028b6af84c 100644 --- a/documentation/kernel-dev/common.rst +++ b/documentation/kernel-dev/common.rst | |||
@@ -1043,7 +1043,7 @@ Using ``menuconfig`` | |||
1043 | The easiest way to define kernel configurations is to set them through | 1043 | The easiest way to define kernel configurations is to set them through |
1044 | the ``menuconfig`` tool. This tool provides an interactive method with | 1044 | the ``menuconfig`` tool. This tool provides an interactive method with |
1045 | which to set kernel configurations. For general information on | 1045 | which to set kernel configurations. For general information on |
1046 | ``menuconfig``, see https://en.wikipedia.org/wiki/Menuconfig. | 1046 | ``menuconfig``, see :wikipedia:`Menuconfig`. |
1047 | 1047 | ||
1048 | To use the ``menuconfig`` tool in the Yocto Project development | 1048 | To use the ``menuconfig`` tool in the Yocto Project development |
1049 | environment, you must do the following: | 1049 | environment, you must do the following: |
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 96aea2f332..90736e6009 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst | |||
@@ -108,7 +108,7 @@ Packaging Changes | |||
108 | 108 | ||
109 | The following packaging changes have occurred. | 109 | The following packaging changes have occurred. |
110 | 110 | ||
111 | - The `Epiphany <https://en.wikipedia.org/wiki/GNOME_Web>`__ browser | 111 | - The :wikipedia:`Epiphany <GNOME_Web>` browser |
112 | has been dropped from ``packagegroup-self-hosted`` as it has not been | 112 | has been dropped from ``packagegroup-self-hosted`` as it has not been |
113 | needed inside ``build-appliance-image`` for quite some time and was | 113 | needed inside ``build-appliance-image`` for quite some time and was |
114 | causing resource problems. | 114 | causing resource problems. |
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index 02d3c3e2bd..17b1d3c619 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst | |||
@@ -183,8 +183,8 @@ a new :term:`KERNEL_DEBUG_TIMESTAMPS` variable to "1". | |||
183 | Supported host distribution changes | 183 | Supported host distribution changes |
184 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 184 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
185 | 185 | ||
186 | - Support for `AlmaLinux <https://en.wikipedia.org/wiki/AlmaLinux>`__ | 186 | - Support for :wikipedia:`AlmaLinux <AlmaLinux>` |
187 | hosts replacing `CentOS <https://en.wikipedia.org/wiki/CentOS>`__. | 187 | hosts replacing :wikipedia:`CentOS <CentOS>`. |
188 | The following distribution versions were dropped: CentOS 8, Ubuntu 16.04 and Fedora 30, 31 and 32. | 188 | The following distribution versions were dropped: CentOS 8, Ubuntu 16.04 and Fedora 30, 31 and 32. |
189 | 189 | ||
190 | - ``gcc`` version 7.5 is now required at minimum on the build host. For older | 190 | - ``gcc`` version 7.5 is now required at minimum on the build host. For older |
diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst index a61ccc6913..02cde0e3f3 100644 --- a/documentation/migration-guides/release-notes-4.0.rst +++ b/documentation/migration-guides/release-notes-4.0.rst | |||
@@ -32,7 +32,7 @@ New Features / Enhancements in 4.0 | |||
32 | :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` classes and | 32 | :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` classes and |
33 | ``overlayroot`` support in the :term:`Initramfs` framework to make it easier to | 33 | ``overlayroot`` support in the :term:`Initramfs` framework to make it easier to |
34 | overlay read-only filesystems (for example) with | 34 | overlay read-only filesystems (for example) with |
35 | `OverlayFS <https://en.wikipedia.org/wiki/OverlayFS>`__. | 35 | :wikipedia:`OverlayFS <OverlayFS>`. |
36 | 36 | ||
37 | - Inclusive language adjustments to some variable names - see the | 37 | - Inclusive language adjustments to some variable names - see the |
38 | :ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details. | 38 | :ref:`4.0 migration guide <migration-4.0-inclusive-language>` for details. |
@@ -104,7 +104,7 @@ New Features / Enhancements in 4.0 | |||
104 | 104 | ||
105 | - Shared state (sstate) improvements: | 105 | - Shared state (sstate) improvements: |
106 | 106 | ||
107 | - Switched to `ZStandard (zstd) <https://en.wikipedia.org/wiki/Zstd>`__ instead | 107 | - Switched to :wikipedia:`ZStandard (zstd) <Zstd>` instead |
108 | of Gzip, for better performance. | 108 | of Gzip, for better performance. |
109 | - Allow validation of sstate signatures against a list of keys | 109 | - Allow validation of sstate signatures against a list of keys |
110 | - Improved error messages and exception handling | 110 | - Improved error messages and exception handling |
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst index b323a6fdf4..c495e4cc41 100644 --- a/documentation/overview-manual/concepts.rst +++ b/documentation/overview-manual/concepts.rst | |||
@@ -110,7 +110,7 @@ Class files (``.bbclass``) contain information that is useful to share | |||
110 | between recipes files. An example is the | 110 | between recipes files. An example is the |
111 | :ref:`autotools <ref-classes-autotools>` class, | 111 | :ref:`autotools <ref-classes-autotools>` class, |
112 | which contains common settings for any application that is built with | 112 | which contains common settings for any application that is built with |
113 | the `GNU Autotools <https://en.wikipedia.org/wiki/GNU_Autotools>`__. | 113 | the :wikipedia:`GNU Autotools <GNU_Autotools>`. |
114 | The ":ref:`ref-manual/classes:Classes`" chapter in the Yocto Project | 114 | The ":ref:`ref-manual/classes:Classes`" chapter in the Yocto Project |
115 | Reference Manual provides details about classes and how to use them. | 115 | Reference Manual provides details about classes and how to use them. |
116 | 116 | ||
@@ -2061,7 +2061,7 @@ dependencies, you must manually declare the dependencies. | |||
2061 | located. For each shared library, the package that contains the | 2061 | located. For each shared library, the package that contains the |
2062 | shared library is registered as providing the shared library. More | 2062 | shared library is registered as providing the shared library. More |
2063 | specifically, the package is registered as providing the | 2063 | specifically, the package is registered as providing the |
2064 | `soname <https://en.wikipedia.org/wiki/Soname>`__ of the library. The | 2064 | :wikipedia:`soname <Soname>` of the library. The |
2065 | resulting shared-library-to-package mapping is saved globally in | 2065 | resulting shared-library-to-package mapping is saved globally in |
2066 | :term:`PKGDATA_DIR` by the | 2066 | :term:`PKGDATA_DIR` by the |
2067 | :ref:`ref-tasks-packagedata` | 2067 | :ref:`ref-tasks-packagedata` |
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 04aea1373c..7d5953db33 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
@@ -39,10 +39,9 @@ Linus Torvalds in 1991. Conversely, a good example of a non-open source | |||
39 | project is the Windows family of operating systems developed by | 39 | project is the Windows family of operating systems developed by |
40 | Microsoft Corporation. | 40 | Microsoft Corporation. |
41 | 41 | ||
42 | Wikipedia has a good historical description of the Open Source | 42 | Wikipedia has a good :wikipedia:`historical description of the Open Source |
43 | Philosophy `here <https://en.wikipedia.org/wiki/Open_source>`__. You can | 43 | Philosophy <Open_source>`. You can also find helpful information on how |
44 | also find helpful information on how to participate in the Linux | 44 | to participate in the Linux Community |
45 | Community | ||
46 | `here <https://www.kernel.org/doc/html/latest/process/index.html>`__. | 45 | `here <https://www.kernel.org/doc/html/latest/process/index.html>`__. |
47 | 46 | ||
48 | The Development Host | 47 | The Development Host |
@@ -608,18 +607,16 @@ licensing structures in place. License evolution for both Open Source | |||
608 | and Free Software has an interesting history. If you are interested in | 607 | and Free Software has an interesting history. If you are interested in |
609 | this history, you can find basic information here: | 608 | this history, you can find basic information here: |
610 | 609 | ||
611 | - `Open source license | 610 | - :wikipedia:`Open source license history <Open-source_license>` |
612 | history <https://en.wikipedia.org/wiki/Open-source_license>`__ | ||
613 | 611 | ||
614 | - `Free software license | 612 | - :wikipedia:`Free software license history <Free_software_license>` |
615 | history <https://en.wikipedia.org/wiki/Free_software_license>`__ | ||
616 | 613 | ||
617 | In general, the Yocto Project is broadly licensed under the | 614 | In general, the Yocto Project is broadly licensed under the |
618 | Massachusetts Institute of Technology (MIT) License. MIT licensing | 615 | Massachusetts Institute of Technology (MIT) License. MIT licensing |
619 | permits the reuse of software within proprietary software as long as the | 616 | permits the reuse of software within proprietary software as long as the |
620 | license is distributed with that software. Patches to the Yocto Project | 617 | license is distributed with that software. Patches to the Yocto Project |
621 | follow the upstream licensing scheme. You can find information on the | 618 | follow the upstream licensing scheme. You can find information on the |
622 | MIT license `here <https://en.wikipedia.org/wiki/MIT_License>`__. | 619 | MIT license :wikipedia:`here <MIT_License>`. |
623 | 620 | ||
624 | When you build an image using the Yocto Project, the build process uses | 621 | When you build an image using the Yocto Project, the build process uses |
625 | a known list of licenses to ensure compliance. You can find this list in | 622 | a known list of licenses to ensure compliance. You can find this list in |
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 0d3d2586b4..6bab15257e 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -85,7 +85,7 @@ about the variable flags (varflags) that help control archive creation. | |||
85 | ====================== | 85 | ====================== |
86 | 86 | ||
87 | The :ref:`autotools* <ref-classes-autotools>` classes support packages built with the | 87 | The :ref:`autotools* <ref-classes-autotools>` classes support packages built with the |
88 | `GNU Autotools <https://en.wikipedia.org/wiki/GNU_Autotools>`__. | 88 | :wikipedia:`GNU Autotools <GNU_Autotools>`. |
89 | 89 | ||
90 | The ``autoconf``, ``automake``, and ``libtool`` packages bring | 90 | The ``autoconf``, ``automake``, and ``libtool`` packages bring |
91 | standardization. This class defines a set of tasks (e.g. ``configure``, | 91 | standardization. This class defines a set of tasks (e.g. ``configure``, |
@@ -1775,8 +1775,8 @@ is not needed. | |||
1775 | ``npm.bbclass`` | 1775 | ``npm.bbclass`` |
1776 | =============== | 1776 | =============== |
1777 | 1777 | ||
1778 | Provides support for building Node.js software fetched using the `node | 1778 | Provides support for building Node.js software fetched using the |
1779 | package manager (NPM) <https://en.wikipedia.org/wiki/Npm_(software)>`__. | 1779 | :wikipedia:`node package manager (NPM) <Npm_(software)>`. |
1780 | 1780 | ||
1781 | .. note:: | 1781 | .. note:: |
1782 | 1782 | ||
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index a5b01e8df7..71d3c5e2aa 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst | |||
@@ -126,10 +126,9 @@ metadata, as extra layers can define their own: | |||
126 | 126 | ||
127 | - *3g:* Include support for cellular data. | 127 | - *3g:* Include support for cellular data. |
128 | 128 | ||
129 | - *acl:* Include | 129 | - *acl:* Include :wikipedia:`Access Control List <Access-control_list>` support. |
130 | `Access Control List <https://en.wikipedia.org/wiki/Access-control_list>`__ support. | ||
131 | 130 | ||
132 | - *alsa:* Include `Advanced Linux Sound Architecture <https://en.wikipedia.org/wiki/Advanced_Linux_Sound_Architecture>`__ | 131 | - *alsa:* Include :wikipedia:`Advanced Linux Sound Architecture <Advanced_Linux_Sound_Architecture>` |
133 | support (OSS compatibility kernel modules installed if available). | 132 | support (OSS compatibility kernel modules installed if available). |
134 | 133 | ||
135 | - *api-documentation:* Enables generation of API documentation during | 134 | - *api-documentation:* Enables generation of API documentation during |
@@ -167,7 +166,7 @@ metadata, as extra layers can define their own: | |||
167 | - *multiarch:* Enable building applications with multiple architecture | 166 | - *multiarch:* Enable building applications with multiple architecture |
168 | support. | 167 | support. |
169 | 168 | ||
170 | - *ld-is-gold:* Use the `gold <https://en.wikipedia.org/wiki/Gold_(linker)>`__ | 169 | - *ld-is-gold:* Use the :wikipedia:`gold <Gold_(linker)>` |
171 | linker instead of the standard GCC linker (bfd). | 170 | linker instead of the standard GCC linker (bfd). |
172 | 171 | ||
173 | - *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the | 172 | - *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the |
@@ -190,14 +189,14 @@ metadata, as extra layers can define their own: | |||
190 | - *overlayfs:* Include `OverlayFS <https://docs.kernel.org/filesystems/overlayfs.html>`__ | 189 | - *overlayfs:* Include `OverlayFS <https://docs.kernel.org/filesystems/overlayfs.html>`__ |
191 | support. | 190 | support. |
192 | 191 | ||
193 | - *pam:* Include `Pluggable Authentication Module (PAM) <https://en.wikipedia.org/wiki/Pluggable_authentication_module>`__ | 192 | - *pam:* Include :wikipedia:`Pluggable Authentication Module (PAM) <Pluggable_authentication_module>` |
194 | support. | 193 | support. |
195 | 194 | ||
196 | - *pci:* Include PCI bus support. | 195 | - *pci:* Include PCI bus support. |
197 | 196 | ||
198 | - *pcmcia:* Include PCMCIA/CompactFlash support. | 197 | - *pcmcia:* Include PCMCIA/CompactFlash support. |
199 | 198 | ||
200 | - *polkit:* Include `Polkit <https://en.wikipedia.org/wiki/Polkit>`__ support. | 199 | - *polkit:* Include :wikipedia:`Polkit <Polkit>` support. |
201 | 200 | ||
202 | - *ppp:* Include PPP dialup support. | 201 | - *ppp:* Include PPP dialup support. |
203 | 202 | ||
@@ -210,11 +209,11 @@ metadata, as extra layers can define their own: | |||
210 | `PulseAudio <https://www.freedesktop.org/wiki/Software/PulseAudio/>`__. | 209 | `PulseAudio <https://www.freedesktop.org/wiki/Software/PulseAudio/>`__. |
211 | 210 | ||
212 | - *selinux:* Include support for | 211 | - *selinux:* Include support for |
213 | `Security-Enhanced Linux (SELinux) <https://en.wikipedia.org/wiki/Security-Enhanced_Linux>`__ | 212 | :wikipedia:`Security-Enhanced Linux (SELinux) <Security-Enhanced_Linux>` |
214 | (requires `meta-selinux <https://layers.openembedded.org/layerindex/layer/meta-selinux/>`__). | 213 | (requires `meta-selinux <https://layers.openembedded.org/layerindex/layer/meta-selinux/>`__). |
215 | 214 | ||
216 | - *seccomp:* Enables building applications with | 215 | - *seccomp:* Enables building applications with |
217 | `seccomp <https://en.wikipedia.org/wiki/Seccomp>`__ support, to | 216 | :wikipedia:`seccomp <Seccomp>` support, to |
218 | allow them to strictly restrict the system calls that they are allowed | 217 | allow them to strictly restrict the system calls that they are allowed |
219 | to invoke. | 218 | to invoke. |
220 | 219 | ||
@@ -236,11 +235,10 @@ metadata, as extra layers can define their own: | |||
236 | directories into their respective counterparts in the ``/usr`` | 235 | directories into their respective counterparts in the ``/usr`` |
237 | directory to provide better package and application compatibility. | 236 | directory to provide better package and application compatibility. |
238 | 237 | ||
239 | - *vfat:* Include `FAT filesystem <https://en.wikipedia.org/wiki/File_Allocation_Table>`__ | 238 | - *vfat:* Include :wikipedia:`FAT filesystem <File_Allocation_Table>` |
240 | support. | 239 | support. |
241 | 240 | ||
242 | - *vulkan:* Include support for the | 241 | - *vulkan:* Include support for the :wikipedia:`Vulkan API <Vulkan>`. |
243 | `Vulkan API <https://en.wikipedia.org/wiki/Vulkan>`__. | ||
244 | 242 | ||
245 | - *wayland:* Include the Wayland display server protocol and the | 243 | - *wayland:* Include the Wayland display server protocol and the |
246 | library that supports it. | 244 | library that supports it. |
@@ -250,7 +248,7 @@ metadata, as extra layers can define their own: | |||
250 | - *x11:* Include the X server and libraries. | 248 | - *x11:* Include the X server and libraries. |
251 | 249 | ||
252 | - *xattr:* Include support for | 250 | - *xattr:* Include support for |
253 | `extended file attributes <https://en.wikipedia.org/wiki/Extended_file_attributes>`__. | 251 | :wikipedia:`extended file attributes <Extended_file_attributes>`. |
254 | 252 | ||
255 | - *zeroconf:* Include support for | 253 | - *zeroconf:* Include support for |
256 | `zero configuration networking <https://en.wikipedia.org/wiki/Zero-configuration_networking>`__. | 254 | `zero configuration networking <https://en.wikipedia.org/wiki/Zero-configuration_networking>`__. |
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index 48bba58995..11bc373b3c 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst | |||
@@ -177,7 +177,7 @@ the ``part`` and ``partition`` commands: | |||
177 | - ``--part-type``: This option is a Wic-specific option that | 177 | - ``--part-type``: This option is a Wic-specific option that |
178 | specifies the partition type globally unique identifier (GUID) for | 178 | specifies the partition type globally unique identifier (GUID) for |
179 | GPT partitions. You can find the list of partition type GUIDs at | 179 | GPT partitions. You can find the list of partition type GUIDs at |
180 | https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. | 180 | :wikipedia:`GUID_Partition_Table#Partition_type_GUIDs`. |
181 | 181 | ||
182 | - ``--use-uuid``: This option is a Wic-specific option that causes | 182 | - ``--use-uuid``: This option is a Wic-specific option that causes |
183 | Wic to generate a random GUID for the partition. The generated | 183 | Wic to generate a random GUID for the partition. The generated |
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index b4a78efad3..51f6e79200 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst | |||
@@ -330,7 +330,7 @@ universal, the list includes them just in case: | |||
330 | This can be used by the recipients of the software to assess | 330 | This can be used by the recipients of the software to assess |
331 | their exposure to license compliance and security vulnerability issues. | 331 | their exposure to license compliance and security vulnerability issues. |
332 | 332 | ||
333 | See the `Software Supply Chain <https://en.wikipedia.org/wiki/Software_supply_chain>`__ | 333 | See the :wikipedia:`Software Supply Chain <Software_supply_chain>` |
334 | article on Wikipedia for more details. | 334 | article on Wikipedia for more details. |
335 | 335 | ||
336 | The OpenEmbedded Build System can generate such documentation for your | 336 | The OpenEmbedded Build System can generate such documentation for your |
@@ -405,7 +405,7 @@ universal, the list includes them just in case: | |||
405 | <https://spdx.dev/>`__ and is used by the OpenEmbedded Build System to | 405 | <https://spdx.dev/>`__ and is used by the OpenEmbedded Build System to |
406 | provide an :term:`SBOM` associated to each a software image. | 406 | provide an :term:`SBOM` associated to each a software image. |
407 | 407 | ||
408 | For details, see Wikipedia's `SPDX page <https://en.wikipedia.org/wiki/Software_Package_Data_Exchange>`__ | 408 | For details, see Wikipedia's :wikipedia:`SPDX page <Software_Package_Data_Exchange>` |
409 | and the ":ref:`dev-manual/common-tasks:creating a software bill of materials`" | 409 | and the ":ref:`dev-manual/common-tasks:creating a software bill of materials`" |
410 | section of the Development Tasks manual. | 410 | section of the Development Tasks manual. |
411 | 411 | ||
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 440e1a0833..9909622d7a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -3699,8 +3699,8 @@ system and gives an overview of their function and contents. | |||
3699 | 3699 | ||
3700 | :term:`Initramfs` | 3700 | :term:`Initramfs` |
3701 | An Initial RAM Filesystem (:term:`Initramfs`) is an optionally compressed | 3701 | An Initial RAM Filesystem (:term:`Initramfs`) is an optionally compressed |
3702 | `cpio <https://en.wikipedia.org/wiki/Cpio>`__ archive which is extracted | 3702 | :wikipedia:`cpio <Cpio>` archive which is extracted |
3703 | by the Linux kernel into RAM in a special `tmpfs <https://en.wikipedia.org/wiki/Tmpfs>`__ | 3703 | by the Linux kernel into RAM in a special :wikipedia:`tmpfs <Tmpfs>` |
3704 | instance, used as the initial root filesystem. | 3704 | instance, used as the initial root filesystem. |
3705 | 3705 | ||
3706 | This is a replacement for the legacy init RAM disk ("initrd") | 3706 | This is a replacement for the legacy init RAM disk ("initrd") |
@@ -3756,7 +3756,7 @@ system and gives an overview of their function and contents. | |||
3756 | ``meta/conf/bitbake.conf`` configuration file in the | 3756 | ``meta/conf/bitbake.conf`` configuration file in the |
3757 | :term:`Source Directory`, is "cpio.gz". The Linux kernel's | 3757 | :term:`Source Directory`, is "cpio.gz". The Linux kernel's |
3758 | :term:`Initramfs` mechanism, as opposed to the initial RAM filesystem | 3758 | :term:`Initramfs` mechanism, as opposed to the initial RAM filesystem |
3759 | `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects | 3759 | :wikipedia:`initrd <Initrd>` mechanism, expects |
3760 | an optionally compressed cpio archive. | 3760 | an optionally compressed cpio archive. |
3761 | 3761 | ||
3762 | :term:`INITRAMFS_IMAGE` | 3762 | :term:`INITRAMFS_IMAGE` |
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst index d6bca44947..66218fccd6 100644 --- a/documentation/sdk-manual/appendix-customizing.rst +++ b/documentation/sdk-manual/appendix-customizing.rst | |||
@@ -176,9 +176,8 @@ the installed SDKs to update the installed SDKs by using the | |||
176 | ``devtool sdk-update`` command: | 176 | ``devtool sdk-update`` command: |
177 | 177 | ||
178 | 1. Create a directory that can be shared over HTTP or HTTPS. You can do | 178 | 1. Create a directory that can be shared over HTTP or HTTPS. You can do |
179 | this by setting up a web server such as an `Apache HTTP | 179 | this by setting up a web server such as an :wikipedia:`Apache HTTP Server |
180 | Server <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ or | 180 | <Apache_HTTP_Server>` or :wikipedia:`Nginx <Nginx>` server in the cloud |
181 | `Nginx <https://en.wikipedia.org/wiki/Nginx>`__ server in the cloud | ||
182 | to host the directory. This directory must contain the published SDK. | 181 | to host the directory. This directory must contain the published SDK. |
183 | 182 | ||
184 | 2. Set the | 183 | 2. Set the |
@@ -262,9 +261,8 @@ source, you need to do a number of things: | |||
262 | 261 | ||
263 | 2. Expose the ``sstate-cache`` directory produced by the build. | 262 | 2. Expose the ``sstate-cache`` directory produced by the build. |
264 | Typically, you expose this directory by making it available through | 263 | Typically, you expose this directory by making it available through |
265 | an `Apache HTTP | 264 | an :wikipedia:`Apache HTTP Server <Apache_HTTP_Server>` or |
266 | Server <https://en.wikipedia.org/wiki/Apache_HTTP_Server>`__ or | 265 | :wikipedia:`Nginx <Nginx>` server. |
267 | `Nginx <https://en.wikipedia.org/wiki/Nginx>`__ server. | ||
268 | 266 | ||
269 | 3. Set the appropriate configuration so that the produced SDK knows how | 267 | 3. Set the appropriate configuration so that the produced SDK knows how |
270 | to find the configuration. The variable you need to set is | 268 | to find the configuration. The variable you need to set is |
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst index 91d8d6ad93..0eddee08e3 100644 --- a/documentation/sdk-manual/working-projects.rst +++ b/documentation/sdk-manual/working-projects.rst | |||
@@ -11,9 +11,9 @@ Autotools-Based Projects | |||
11 | ======================== | 11 | ======================== |
12 | 12 | ||
13 | Once you have a suitable :ref:`sdk-manual/intro:the cross-development toolchain` | 13 | Once you have a suitable :ref:`sdk-manual/intro:the cross-development toolchain` |
14 | installed, it is very easy to develop a project using the `GNU | 14 | installed, it is very easy to develop a project using the :wikipedia:`GNU |
15 | Autotools-based <https://en.wikipedia.org/wiki/GNU_Build_System>`__ | 15 | Autotools-based <GNU_Build_System>` workflow, which is outside of the |
16 | workflow, which is outside of the :term:`OpenEmbedded Build System`. | 16 | :term:`OpenEmbedded Build System`. |
17 | 17 | ||
18 | The following figure presents a simple Autotools workflow. | 18 | The following figure presents a simple Autotools workflow. |
19 | 19 | ||
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 36958d00ad..0831f80466 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
@@ -74,8 +74,7 @@ simple JSON files. | |||
74 | The project uses Buildbot for historical reasons but also because | 74 | The project uses Buildbot for historical reasons but also because |
75 | many of the project developers have knowledge of Python. It is | 75 | many of the project developers have knowledge of Python. It is |
76 | possible to use the outer layers from another Continuous Integration | 76 | possible to use the outer layers from another Continuous Integration |
77 | (CI) system such as | 77 | (CI) system such as :wikipedia:`Jenkins <Jenkins_(software)>` |
78 | `Jenkins <https://en.wikipedia.org/wiki/Jenkins_(software)>`__ | ||
79 | instead of Buildbot. | 78 | instead of Buildbot. |
80 | 79 | ||
81 | The following figure shows the Yocto Project Autobuilder stack with a | 80 | The following figure shows the Yocto Project Autobuilder stack with a |
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst index b181d12d86..f8aabeed04 100644 --- a/documentation/toaster-manual/reference.rst +++ b/documentation/toaster-manual/reference.rst | |||
@@ -28,8 +28,7 @@ at :oe_layerindex:`/`. You can find the code for this | |||
28 | layer index's web application at :yocto_git:`/layerindex-web/`. | 28 | layer index's web application at :yocto_git:`/layerindex-web/`. |
29 | 29 | ||
30 | When you tie a layer source into Toaster, it can query the layer source | 30 | When you tie a layer source into Toaster, it can query the layer source |
31 | through a | 31 | through a :wikipedia:`REST <Representational_state_transfer>` |
32 | `REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__ | ||
33 | API, store the information about the layers in the Toaster database, and | 32 | API, store the information about the layers in the Toaster database, and |
34 | then show the information to users. Users are then able to view that | 33 | then show the information to users. Users are then able to view that |
35 | information and build layers from Toaster itself without having to | 34 | information and build layers from Toaster itself without having to |
@@ -369,8 +368,8 @@ Remote Toaster Monitoring | |||
369 | Toaster has an API that allows remote management applications to | 368 | Toaster has an API that allows remote management applications to |
370 | directly query the state of the Toaster server and its builds in a | 369 | directly query the state of the Toaster server and its builds in a |
371 | machine-to-machine manner. This API uses the | 370 | machine-to-machine manner. This API uses the |
372 | `REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__ | 371 | :wikipedia:`REST <Representational_state_transfer>` interface and the |
373 | interface and the transfer of JSON files. For example, you might monitor | 372 | transfer of JSON files. For example, you might monitor |
374 | a build inside a container through well supported known HTTP ports in | 373 | a build inside a container through well supported known HTTP ports in |
375 | order to easily access a Toaster server inside the container. In this | 374 | order to easily access a Toaster server inside the container. In this |
376 | example, when you use this direct JSON API, you avoid having web page | 375 | example, when you use this direct JSON API, you avoid having web page |