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/ref-manual | |
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/ref-manual')
-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 |
5 files changed, 19 insertions, 21 deletions
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` |