From 28afbf81ecb34add93f5eed2c1a41ec5f278d0a7 Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 30 Jul 2020 13:37:11 +0200 Subject: 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: ` `__. 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 Signed-off-by: Richard Purdie --- documentation/ref-manual/faq.rst | 2 +- documentation/ref-manual/migration.rst | 16 ++++++++-------- documentation/ref-manual/ref-classes.rst | 2 +- documentation/ref-manual/ref-devtool-reference.rst | 2 +- documentation/ref-manual/ref-kickstart.rst | 2 +- documentation/ref-manual/ref-qa-checks.rst | 2 +- documentation/ref-manual/ref-release-process.rst | 4 ++-- documentation/ref-manual/ref-variables.rst | 20 ++++++++++---------- 8 files changed, 25 insertions(+), 25 deletions(-) (limited to 'documentation/ref-manual') 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. particular, "external-*" refers to external toolchains. One example is the Sourcery G++ Toolchain. The support for this toolchain resides in the separate ``meta-sourcery`` layer at -` `__. +http://github.com/MentorEmbedded/meta-sourcery/. In addition to the toolchain configuration, you also need a corresponding 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: - ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict with ``multilib``. See - ```YOCTO #4993`` `__ + ```YOCTO #4993`https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993 in Bugzilla for more information. - ``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 for the same issue. -For further details, see ` `__ +For further details, see https://gcc.gnu.org/gcc-5/changes.html and the porting guide at -` `__. +https://gcc.gnu.org/gcc-5/porting_to.html. Alternatively, you can switch back to GCC 4.9 or 4.8 by setting ``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 ``${prefix}/libexec`` or ``${libdir}``. The use is also contrary to the GNU Coding Standards (i.e. -` `__) +https://www.gnu.org/prep/standards/html_node/Directory-Variables.html) that suggest ``${prefix}/libexec`` and also notes that any package-specific nesting should be done by the package itself. Finally, having ``libexecdir`` change between recipes makes it very difficult for different recipes to invoke binaries that have been installed into ``libexecdir``. The Filesystem Hierarchy Standard (i.e. -` `__) now +http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now recognizes the use of ``${prefix}/libexec/``, giving distributions the choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without 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 compilation. For more information on what has changed in the GCC 8.x -release, see ` `__. +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. 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. - Perl now builds for the target using - ```perl-cross`` `__ for better + ```perl-cross`http://arsv.github.io/perl-cross/ for better maintainability and improved build performance. This change should not present any problems unless you have heavily customized your Perl recipe. @@ -4690,7 +4690,7 @@ The following BitBake changes have occurred. ```BB_HASHCHECK_FUNCTION`` <&YOCTO_DOCS_BB_URL;#var-bb-BB_HASHCHECK_FUNCTION>`__ have changed. If you are using your own custom hash check function, see - ` `__ + http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725 for details. - 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. 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 is recommended that you do not use this class. See -` `__ for information on the C/C++ Compiler +http://ccache.samba.org/ for information on the C/C++ Compiler Cache. .. _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. .. note:: - For the ``oe-core`` layer, recipe maintainers come from the - ```maintainers.inc`` `__ + ```maintainers.inc`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/distro/include/maintainers.inc file. - 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: - *``--part-type``:* This option is a Wic-specific option that specifies the partition type globally unique identifier (GUID) for GPT partitions. You can find the list of partition type GUIDs at - ` `__. + http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. - *``--use-uuid``:* This option is a Wic-specific option that causes 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 you could add the following to your recipe: CFLAGS_append = " -fPIC " For more information on text relocations at runtime, see - ` `__. + http://www.akkadia.org/drepper/textrelocs.html.   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. 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 Project releases and codenames at -` `__. +https://wiki.yoctoproject.org/wiki/Releases. 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 through the same release process as do point releases. You can find more information about stable branch maintenance at -` `__. +https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance. Testing and Quality Assurance ============================= 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. software. When specifying recipe files, you can pattern match using Python's - ```glob`` `__ syntax. + ```glob`https://docs.python.org/3/library/glob.html syntax. For details on the syntax, see the documentation by following the previous link. @@ -604,7 +604,7 @@ system and gives an overview of their function and contents. compiler. Consequently, the syntax follows Python's Regular Expression (re) syntax. The expressions are compared against the full paths to the files. For complete syntax information, see Python's - documentation at ` `__. + documentation at http://docs.python.org/3/library/re.html#re. The following example uses a complete regular expression to tell 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 Python's - ```glob`` `__ + ```glob`https://docs.python.org/2/library/glob.html syntax. For details on the syntax, see the documentation by 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} = "-r netdev" For information on the standard Linux shell command - ``groupadd``, see ` `__. + ``groupadd``, see http://linux.die.net/man/8/groupadd. GROUPMEMS_PARAM When inheriting the :ref:`useradd ` class, @@ -2444,7 +2444,7 @@ system and gives an overview of their function and contents. of a group when the package is installed. For information on the standard Linux shell command ``groupmems``, - see ` `__. + see http://linux.die.net/man/8/groupmems. GRUB_GFXSERIAL 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 ``update-rc.d`` command. For more information on valid parameters, please see the ``update-rc.d`` manual page at - ` `__. + http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d. INSANE_SKIP 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. module_conf - Specifies ```modprobe.d`` `__ + Specifies ```modprobe.d`http://linux.die.net/man/5/modprobe.d syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` 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 this toolchain resides in the separate Mentor Graphics ``meta-sourcery`` layer at - ` `__. + http://github.com/MentorEmbedded/meta-sourcery/. The layer's ``README`` file contains information on how to use the 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. For more information on how the ``UBOOT_CONFIG`` is handled, see the - ```uboot-config`` `__ + ```uboot-config`http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/uboot-config.bbclass class. UBOOT_ENTRYPOINT @@ -7787,7 +7787,7 @@ system and gives an overview of their function and contents. "--system --home ${localstatedir}/lib/dbus \\ --no-create-home --shell /bin/false \\ --user-group messagebus" For information on the standard Linux shell command ``useradd``, see - ` `__. + http://linux.die.net/man/8/useradd. USERADD_UID_TABLES Specifies a password file to use for obtaining static user -- cgit v1.2.3-54-g00ecf