summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-30 13:37:11 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:34 +0100
commit28afbf81ecb34add93f5eed2c1a41ec5f278d0a7 (patch)
tree62804dd25f10e4a3781268549cde2aba8bafcb03 /documentation/ref-manual
parent283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (diff)
downloadpoky-28afbf81ecb34add93f5eed2c1a41ec5f278d0a7.tar.gz
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>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/faq.rst2
-rw-r--r--documentation/ref-manual/migration.rst16
-rw-r--r--documentation/ref-manual/ref-classes.rst2
-rw-r--r--documentation/ref-manual/ref-devtool-reference.rst2
-rw-r--r--documentation/ref-manual/ref-kickstart.rst2
-rw-r--r--documentation/ref-manual/ref-qa-checks.rst2
-rw-r--r--documentation/ref-manual/ref-release-process.rst4
-rw-r--r--documentation/ref-manual/ref-variables.rst20
8 files changed, 25 insertions, 25 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index dbd2aaf159..e25f0b278c 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -263,7 +263,7 @@ OpenEmbedded build system to use its internally built toolchain (i.e.
263particular, "external-*" refers to external toolchains. One example is 263particular, "external-*" refers to external toolchains. One example is
264the Sourcery G++ Toolchain. The support for this toolchain resides in 264the Sourcery G++ Toolchain. The support for this toolchain resides in
265the separate ``meta-sourcery`` layer at 265the separate ``meta-sourcery`` layer at
266` <http://github.com/MentorEmbedded/meta-sourcery/>`__. 266http://github.com/MentorEmbedded/meta-sourcery/.
267 267
268In addition to the toolchain configuration, you also need a 268In addition to the toolchain configuration, you also need a
269corresponding toolchain recipe file. This recipe file needs to package 269corresponding toolchain recipe file. This recipe file needs to package
diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst
index 377932e2cf..a678580978 100644
--- a/documentation/ref-manual/migration.rst
+++ b/documentation/ref-manual/migration.rst
@@ -836,7 +836,7 @@ Following is a list of short entries describing other changes:
836 836
837- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict 837- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict
838 with ``multilib``. See 838 with ``multilib``. See
839 ```YOCTO #4993`` <https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993>`__ 839 ```YOCTO #4993`https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993
840 in Bugzilla for more information. 840 in Bugzilla for more information.
841 841
842- ``linux-dtb``: Use kernel build system to generate the ``dtb`` files. 842- ``linux-dtb``: Use kernel build system to generate the ``dtb`` files.
@@ -1658,9 +1658,9 @@ apply this
1658The standard ``linux-yocto`` kernel source tree already has a workaround 1658The standard ``linux-yocto`` kernel source tree already has a workaround
1659for the same issue. 1659for the same issue.
1660 1660
1661For further details, see ` <https://gcc.gnu.org/gcc-5/changes.html>`__ 1661For further details, see https://gcc.gnu.org/gcc-5/changes.html
1662and the porting guide at 1662and the porting guide at
1663` <https://gcc.gnu.org/gcc-5/porting_to.html>`__. 1663https://gcc.gnu.org/gcc-5/porting_to.html.
1664 1664
1665Alternatively, you can switch back to GCC 4.9 or 4.8 by setting 1665Alternatively, you can switch back to GCC 4.9 or 4.8 by setting
1666``GCCVERSION`` in your configuration, as follows: GCCVERSION = "4.9%" 1666``GCCVERSION`` in your configuration, as follows: GCCVERSION = "4.9%"
@@ -1991,13 +1991,13 @@ The use of ``${libdir}/${BPN}`` as ``libexecdir`` is different as
1991compared to all other mainstream distributions, which either uses 1991compared to all other mainstream distributions, which either uses
1992``${prefix}/libexec`` or ``${libdir}``. The use is also contrary to the 1992``${prefix}/libexec`` or ``${libdir}``. The use is also contrary to the
1993GNU Coding Standards (i.e. 1993GNU Coding Standards (i.e.
1994` <https://www.gnu.org/prep/standards/html_node/Directory-Variables.html>`__) 1994https://www.gnu.org/prep/standards/html_node/Directory-Variables.html)
1995that suggest ``${prefix}/libexec`` and also notes that any 1995that suggest ``${prefix}/libexec`` and also notes that any
1996package-specific nesting should be done by the package itself. Finally, 1996package-specific nesting should be done by the package itself. Finally,
1997having ``libexecdir`` change between recipes makes it very difficult for 1997having ``libexecdir`` change between recipes makes it very difficult for
1998different recipes to invoke binaries that have been installed into 1998different recipes to invoke binaries that have been installed into
1999``libexecdir``. The Filesystem Hierarchy Standard (i.e. 1999``libexecdir``. The Filesystem Hierarchy Standard (i.e.
2000` <http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html>`__) now 2000http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now
2001recognizes the use of ``${prefix}/libexec/``, giving distributions the 2001recognizes the use of ``${prefix}/libexec/``, giving distributions the
2002choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without 2002choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without
2003breaking FHS. 2003breaking FHS.
@@ -3874,7 +3874,7 @@ GCC 8.2 is Now Used by Default
3874 3874
3875The GNU Compiler Collection version 8.2 is now used by default for 3875The GNU Compiler Collection version 8.2 is now used by default for
3876compilation. For more information on what has changed in the GCC 8.x 3876compilation. For more information on what has changed in the GCC 8.x
3877release, see ` <https://gcc.gnu.org/gcc-8/changes.html>`__. 3877release, see https://gcc.gnu.org/gcc-8/changes.html.
3878 3878
3879If you still need to compile with version 7.x, GCC 7.3 is also provided. 3879If you still need to compile with version 7.x, GCC 7.3 is also provided.
3880You can select this version by setting the and can be selected by 3880You can select this version by setting the and can be selected by
@@ -4472,7 +4472,7 @@ The following miscellaneous changes occurred:
4472 from the top-level ``scripts`` directory. 4472 from the top-level ``scripts`` directory.
4473 4473
4474- Perl now builds for the target using 4474- Perl now builds for the target using
4475 ```perl-cross`` <http://arsv.github.io/perl-cross/>`__ for better 4475 ```perl-cross`http://arsv.github.io/perl-cross/ for better
4476 maintainability and improved build performance. This change should 4476 maintainability and improved build performance. This change should
4477 not present any problems unless you have heavily customized your Perl 4477 not present any problems unless you have heavily customized your Perl
4478 recipe. 4478 recipe.
@@ -4690,7 +4690,7 @@ The following BitBake changes have occurred.
4690 ```BB_HASHCHECK_FUNCTION`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_HASHCHECK_FUNCTION>`__ 4690 ```BB_HASHCHECK_FUNCTION`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_HASHCHECK_FUNCTION>`__
4691 have changed. If you are using your own custom hash check function, 4691 have changed. If you are using your own custom hash check function,
4692 see 4692 see
4693 ` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725>`__ 4693 http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725
4694 for details. 4694 for details.
4695 4695
4696- Task specifications in ``BB_TASKDEPDATA`` and class implementations 4696- Task specifications in ``BB_TASKDEPDATA`` and class implementations
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index ae5f0e40d1..ace69e15a7 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -283,7 +283,7 @@ The ``ccache`` class enables the C/C++ Compiler Cache for the build.
283This class is used to give a minor performance boost during the build. 283This class is used to give a minor performance boost during the build.
284However, using the class can lead to unexpected side-effects. Thus, it 284However, using the class can lead to unexpected side-effects. Thus, it
285is recommended that you do not use this class. See 285is recommended that you do not use this class. See
286` <http://ccache.samba.org/>`__ for information on the C/C++ Compiler 286http://ccache.samba.org/ for information on the C/C++ Compiler
287Cache. 287Cache.
288 288
289.. _ref-classes-chrpath: 289.. _ref-classes-chrpath:
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst
index 8965b38ffa..418c9623f6 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -287,7 +287,7 @@ particular recipe.
287.. note:: 287.. note::
288 288
289 - For the ``oe-core`` layer, recipe maintainers come from the 289 - For the ``oe-core`` layer, recipe maintainers come from the
290 ```maintainers.inc`` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc>`__ 290 ```maintainers.inc`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc
291 file. 291 file.
292 292
293 - If the recipe is using the `Git 293 - If the recipe is using the `Git
diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst
index 5f8c834f33..271e6e8509 100644
--- a/documentation/ref-manual/ref-kickstart.rst
+++ b/documentation/ref-manual/ref-kickstart.rst
@@ -155,7 +155,7 @@ the ``part`` and ``partition`` commands:
155- *``--part-type``:* This option is a Wic-specific option that 155- *``--part-type``:* This option is a Wic-specific option that
156 specifies the partition type globally unique identifier (GUID) for 156 specifies the partition type globally unique identifier (GUID) for
157 GPT partitions. You can find the list of partition type GUIDs at 157 GPT partitions. You can find the list of partition type GUIDs at
158 ` <http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs>`__. 158 http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs.
159 159
160- *``--use-uuid``:* This option is a Wic-specific option that causes 160- *``--use-uuid``:* This option is a Wic-specific option that causes
161 Wic to generate a random GUID for the partition. The generated 161 Wic to generate a random GUID for the partition. The generated
diff --git a/documentation/ref-manual/ref-qa-checks.rst b/documentation/ref-manual/ref-qa-checks.rst
index d60c0616f0..a56de690b1 100644
--- a/documentation/ref-manual/ref-qa-checks.rst
+++ b/documentation/ref-manual/ref-qa-checks.rst
@@ -212,7 +212,7 @@ Errors and Warnings
212 you could add the following to your recipe: CFLAGS_append = " -fPIC " 212 you could add the following to your recipe: CFLAGS_append = " -fPIC "
213 213
214 For more information on text relocations at runtime, see 214 For more information on text relocations at runtime, see
215 ` <http://www.akkadia.org/drepper/textrelocs.html>`__. 215 http://www.akkadia.org/drepper/textrelocs.html.
216 216
217   217  
218 218
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst
index 832f011918..7b33c0ae6b 100644
--- a/documentation/ref-manual/ref-release-process.rst
+++ b/documentation/ref-manual/ref-release-process.rst
@@ -54,7 +54,7 @@ codename are likely to be compatible and thus work together.
54Releases are given a nominal release version as well but the codename is 54Releases are given a nominal release version as well but the codename is
55used in repositories for this reason. You can find information on Yocto 55used in repositories for this reason. You can find information on Yocto
56Project releases and codenames at 56Project releases and codenames at
57` <https://wiki.yoctoproject.org/wiki/Releases>`__. 57https://wiki.yoctoproject.org/wiki/Releases.
58 58
59Stable Release Process 59Stable Release Process
60====================== 60======================
@@ -84,7 +84,7 @@ Community LTS trees and branches exist where community members share
84patches for older releases. However, these types of patches do not go 84patches for older releases. However, these types of patches do not go
85through the same release process as do point releases. You can find more 85through the same release process as do point releases. You can find more
86information about stable branch maintenance at 86information about stable branch maintenance at
87` <https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance>`__. 87https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance.
88 88
89Testing and Quality Assurance 89Testing and Quality Assurance
90============================= 90=============================
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 53e99a395a..205a060103 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -546,7 +546,7 @@ system and gives an overview of their function and contents.
546 software. 546 software.
547 547
548 When specifying recipe files, you can pattern match using Python's 548 When specifying recipe files, you can pattern match using Python's
549 ```glob`` <https://docs.python.org/3/library/glob.html>`__ syntax. 549 ```glob`https://docs.python.org/3/library/glob.html syntax.
550 For details on the syntax, see the documentation by following the 550 For details on the syntax, see the documentation by following the
551 previous link. 551 previous link.
552 552
@@ -604,7 +604,7 @@ system and gives an overview of their function and contents.
604 compiler. Consequently, the syntax follows Python's Regular 604 compiler. Consequently, the syntax follows Python's Regular
605 Expression (re) syntax. The expressions are compared against the full 605 Expression (re) syntax. The expressions are compared against the full
606 paths to the files. For complete syntax information, see Python's 606 paths to the files. For complete syntax information, see Python's
607 documentation at ` <http://docs.python.org/3/library/re.html#re>`__. 607 documentation at http://docs.python.org/3/library/re.html#re.
608 608
609 The following example uses a complete regular expression to tell 609 The following example uses a complete regular expression to tell
610 BitBake to ignore all recipe and recipe append files in the 610 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.
2173 2173
2174 - When specifying files or paths, you can pattern match using 2174 - When specifying files or paths, you can pattern match using
2175 Python's 2175 Python's
2176 ```glob`` <https://docs.python.org/2/library/glob.html>`__ 2176 ```glob`https://docs.python.org/2/library/glob.html
2177 syntax. For details on the syntax, see the documentation by 2177 syntax. For details on the syntax, see the documentation by
2178 following the previous link. 2178 following the previous link.
2179 2179
@@ -2435,7 +2435,7 @@ system and gives an overview of their function and contents.
2435 2435
2436 Here is an example from the ``dbus`` recipe: GROUPADD_PARAM_${PN} = 2436 Here is an example from the ``dbus`` recipe: GROUPADD_PARAM_${PN} =
2437 "-r netdev" For information on the standard Linux shell command 2437 "-r netdev" For information on the standard Linux shell command
2438 ``groupadd``, see ` <http://linux.die.net/man/8/groupadd>`__. 2438 ``groupadd``, see http://linux.die.net/man/8/groupadd.
2439 2439
2440 GROUPMEMS_PARAM 2440 GROUPMEMS_PARAM
2441 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 2441 When inheriting the :ref:`useradd <ref-classes-useradd>` class,
@@ -2444,7 +2444,7 @@ system and gives an overview of their function and contents.
2444 of a group when the package is installed. 2444 of a group when the package is installed.
2445 2445
2446 For information on the standard Linux shell command ``groupmems``, 2446 For information on the standard Linux shell command ``groupmems``,
2447 see ` <http://linux.die.net/man/8/groupmems>`__. 2447 see http://linux.die.net/man/8/groupmems.
2448 2448
2449 GRUB_GFXSERIAL 2449 GRUB_GFXSERIAL
2450 Configures the GNU GRand Unified Bootloader (GRUB) to have graphics 2450 Configures the GNU GRand Unified Bootloader (GRUB) to have graphics
@@ -3313,7 +3313,7 @@ system and gives an overview of their function and contents.
3313 The value in ``INITSCRIPT_PARAMS`` is passed through to the 3313 The value in ``INITSCRIPT_PARAMS`` is passed through to the
3314 ``update-rc.d`` command. For more information on valid parameters, 3314 ``update-rc.d`` command. For more information on valid parameters,
3315 please see the ``update-rc.d`` manual page at 3315 please see the ``update-rc.d`` manual page at
3316 ` <http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d>`__. 3316 http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d.
3317 3317
3318 INSANE_SKIP 3318 INSANE_SKIP
3319 Specifies the QA checks to skip for a specific package within a 3319 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.
4193 variable for more information. 4193 variable for more information.
4194 4194
4195 module_conf 4195 module_conf
4196 Specifies ```modprobe.d`` <http://linux.die.net/man/5/modprobe.d>`__ 4196 Specifies ```modprobe.d`http://linux.die.net/man/5/modprobe.d
4197 syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` 4197 syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf``
4198 file. 4198 file.
4199 4199
@@ -7069,7 +7069,7 @@ system and gives an overview of their function and contents.
7069 toolchain. One example is the Sourcery G++ Toolchain. The support for 7069 toolchain. One example is the Sourcery G++ Toolchain. The support for
7070 this toolchain resides in the separate Mentor Graphics 7070 this toolchain resides in the separate Mentor Graphics
7071 ``meta-sourcery`` layer at 7071 ``meta-sourcery`` layer at
7072 ` <http://github.com/MentorEmbedded/meta-sourcery/>`__. 7072 http://github.com/MentorEmbedded/meta-sourcery/.
7073 7073
7074 The layer's ``README`` file contains information on how to use the 7074 The layer's ``README`` file contains information on how to use the
7075 Sourcery G++ Toolchain as an external toolchain. In summary, you must 7075 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.
7527 "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-boot image. 7527 "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-boot image.
7528 7528
7529 For more information on how the ``UBOOT_CONFIG`` is handled, see the 7529 For more information on how the ``UBOOT_CONFIG`` is handled, see the
7530 ```uboot-config`` <http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/uboot-config.bbclass>`__ 7530 ```uboot-config`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/uboot-config.bbclass
7531 class. 7531 class.
7532 7532
7533 UBOOT_ENTRYPOINT 7533 UBOOT_ENTRYPOINT
@@ -7787,7 +7787,7 @@ system and gives an overview of their function and contents.
7787 "--system --home ${localstatedir}/lib/dbus \\ --no-create-home 7787 "--system --home ${localstatedir}/lib/dbus \\ --no-create-home
7788 --shell /bin/false \\ --user-group messagebus" For information on the 7788 --shell /bin/false \\ --user-group messagebus" For information on the
7789 standard Linux shell command ``useradd``, see 7789 standard Linux shell command ``useradd``, see
7790 ` <http://linux.die.net/man/8/useradd>`__. 7790 http://linux.die.net/man/8/useradd.
7791 7791
7792 USERADD_UID_TABLES 7792 USERADD_UID_TABLES
7793 Specifies a password file to use for obtaining static user 7793 Specifies a password file to use for obtaining static user