diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-30 13:37:11 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:34 +0100 |
commit | 28afbf81ecb34add93f5eed2c1a41ec5f278d0a7 (patch) | |
tree | 62804dd25f10e4a3781268549cde2aba8bafcb03 /documentation/adt-manual | |
parent | 283ed72d487ed78d4f8e0fcc17f635d6c212b7c6 (diff) | |
download | poky-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/adt-manual')
-rw-r--r-- | documentation/adt-manual/adt-intro.rst | 10 | ||||
-rw-r--r-- | documentation/adt-manual/adt-package.rst | 6 | ||||
-rw-r--r-- | documentation/adt-manual/adt-prepare.rst | 4 |
3 files changed, 10 insertions, 10 deletions
diff --git a/documentation/adt-manual/adt-intro.rst b/documentation/adt-manual/adt-intro.rst index d6228ad864..5372f4f54f 100644 --- a/documentation/adt-manual/adt-intro.rst +++ b/documentation/adt-manual/adt-intro.rst | |||
@@ -107,18 +107,18 @@ tools are common development tools for the Linux platform. | |||
107 | 107 | ||
108 | - *PowerTOP:* Helps you determine what software is using the most | 108 | - *PowerTOP:* Helps you determine what software is using the most |
109 | power. You can find out more about PowerTOP at | 109 | power. You can find out more about PowerTOP at |
110 | ` <https://01.org/powertop/>`__. | 110 | https://01.org/powertop/. |
111 | 111 | ||
112 | - *OProfile:* A system-wide profiler for Linux systems that is capable | 112 | - *OProfile:* A system-wide profiler for Linux systems that is capable |
113 | of profiling all running code at low overhead. You can find out more | 113 | of profiling all running code at low overhead. You can find out more |
114 | about OProfile at ` <http://oprofile.sourceforge.net/about/>`__. For | 114 | about OProfile at http://oprofile.sourceforge.net/about/. For |
115 | examples on how to setup and use this tool, see the | 115 | examples on how to setup and use this tool, see the |
116 | "`OProfile <&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile>`__" | 116 | "`OProfile <&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile>`__" |
117 | section in the Yocto Project Profiling and Tracing Manual. | 117 | section in the Yocto Project Profiling and Tracing Manual. |
118 | 118 | ||
119 | - *Perf:* Performance counters for Linux used to keep track of certain | 119 | - *Perf:* Performance counters for Linux used to keep track of certain |
120 | types of hardware and software events. For more information on these | 120 | types of hardware and software events. For more information on these |
121 | types of counters see ` <https://perf.wiki.kernel.org/>`__. For | 121 | types of counters see https://perf.wiki.kernel.org/. For |
122 | examples on how to setup and use this tool, see the | 122 | examples on how to setup and use this tool, see the |
123 | "`perf <&YOCTO_DOCS_PROF_URL;#profile-manual-perf>`__" section in the | 123 | "`perf <&YOCTO_DOCS_PROF_URL;#profile-manual-perf>`__" section in the |
124 | Yocto Project Profiling and Tracing Manual. | 124 | Yocto Project Profiling and Tracing Manual. |
@@ -127,12 +127,12 @@ tools are common development tools for the Linux platform. | |||
127 | information gathering about a running Linux system. This information | 127 | information gathering about a running Linux system. This information |
128 | helps you diagnose performance or functional problems. SystemTap is | 128 | helps you diagnose performance or functional problems. SystemTap is |
129 | not available as a user-space tool through the Eclipse IDE Yocto | 129 | not available as a user-space tool through the Eclipse IDE Yocto |
130 | Plug-in. See ` <http://sourceware.org/systemtap>`__ for more | 130 | Plug-in. See http://sourceware.org/systemtap for more |
131 | information on SystemTap. For examples on how to setup and use this | 131 | information on SystemTap. For examples on how to setup and use this |
132 | tool, see the | 132 | tool, see the |
133 | "`SystemTap <&YOCTO_DOCS_PROF_URL;#profile-manual-systemtap>`__" | 133 | "`SystemTap <&YOCTO_DOCS_PROF_URL;#profile-manual-systemtap>`__" |
134 | section in the Yocto Project Profiling and Tracing Manual. | 134 | section in the Yocto Project Profiling and Tracing Manual. |
135 | 135 | ||
136 | - *Lttng-ust:* A User-space Tracer designed to provide detailed | 136 | - *Lttng-ust:* A User-space Tracer designed to provide detailed |
137 | information on user-space activity. See ` <http://lttng.org/ust>`__ | 137 | information on user-space activity. See http://lttng.org/ust |
138 | for more information on Lttng-ust. | 138 | for more information on Lttng-ust. |
diff --git a/documentation/adt-manual/adt-package.rst b/documentation/adt-manual/adt-package.rst index dfa62163b3..787d406e65 100644 --- a/documentation/adt-manual/adt-package.rst +++ b/documentation/adt-manual/adt-package.rst | |||
@@ -20,19 +20,19 @@ using three different Package Management Systems (PMS): | |||
20 | - *OPKG:* A less well known PMS whose use originated in the | 20 | - *OPKG:* A less well known PMS whose use originated in the |
21 | OpenEmbedded and OpenWrt embedded Linux projects. This PMS works with | 21 | OpenEmbedded and OpenWrt embedded Linux projects. This PMS works with |
22 | files packaged in an ``.ipk`` format. See | 22 | files packaged in an ``.ipk`` format. See |
23 | ` <http://en.wikipedia.org/wiki/Opkg>`__ for more information about | 23 | http://en.wikipedia.org/wiki/Opkg for more information about |
24 | OPKG. | 24 | OPKG. |
25 | 25 | ||
26 | - *RPM:* A more widely known PMS intended for GNU/Linux distributions. | 26 | - *RPM:* A more widely known PMS intended for GNU/Linux distributions. |
27 | This PMS works with files packaged in an ``.rpm`` format. The build | 27 | This PMS works with files packaged in an ``.rpm`` format. The build |
28 | system currently installs through this PMS by default. See | 28 | system currently installs through this PMS by default. See |
29 | ` <http://en.wikipedia.org/wiki/RPM_Package_Manager>`__ for more | 29 | http://en.wikipedia.org/wiki/RPM_Package_Manager for more |
30 | information about RPM. | 30 | information about RPM. |
31 | 31 | ||
32 | - *Debian:* The PMS for Debian-based systems is built on many PMS | 32 | - *Debian:* The PMS for Debian-based systems is built on many PMS |
33 | tools. The lower-level PMS tool ``dpkg`` forms the base of the Debian | 33 | tools. The lower-level PMS tool ``dpkg`` forms the base of the Debian |
34 | PMS. For information on dpkg see | 34 | PMS. For information on dpkg see |
35 | ` <http://en.wikipedia.org/wiki/Dpkg>`__. | 35 | http://en.wikipedia.org/wiki/Dpkg. |
36 | 36 | ||
37 | Configuring the PMS | 37 | Configuring the PMS |
38 | =================== | 38 | =================== |
diff --git a/documentation/adt-manual/adt-prepare.rst b/documentation/adt-manual/adt-prepare.rst index 27133d21b4..e2141f8059 100644 --- a/documentation/adt-manual/adt-prepare.rst +++ b/documentation/adt-manual/adt-prepare.rst | |||
@@ -137,7 +137,7 @@ comments in the ``adt-installer.conf`` file: | |||
137 | set up your own IPKG repository pointed to by ``YOCTOADT_REPO``, you | 137 | set up your own IPKG repository pointed to by ``YOCTOADT_REPO``, you |
138 | need to be sure that the directory structure follows the same layout | 138 | need to be sure that the directory structure follows the same layout |
139 | as the reference directory set up at | 139 | as the reference directory set up at |
140 | ` <http://adtrepo.yoctoproject.org>`__. Also, your repository needs | 140 | http://adtrepo.yoctoproject.org. Also, your repository needs |
141 | to be accessible through HTTP. | 141 | to be accessible through HTTP. |
142 | 142 | ||
143 | - ``YOCTOADT_TARGETS``: The machine target architectures for which you | 143 | - ``YOCTOADT_TARGETS``: The machine target architectures for which you |
@@ -572,7 +572,7 @@ follows: | |||
572 | A good example of an external toolchain used with the Yocto Project is | 572 | A good example of an external toolchain used with the Yocto Project is |
573 | Mentor Graphics Sourcery G++ Toolchain. You can see information on how | 573 | Mentor Graphics Sourcery G++ Toolchain. You can see information on how |
574 | to use that particular layer in the ``README`` file at | 574 | to use that particular layer in the ``README`` file at |
575 | ` <http://github.com/MentorEmbedded/meta-sourcery/>`__. You can find | 575 | http://github.com/MentorEmbedded/meta-sourcery/. You can find |
576 | further information by reading about the | 576 | further information by reading about the |
577 | :term:`TCMODE` variable in the Yocto | 577 | :term:`TCMODE` variable in the Yocto |
578 | Project Reference Manual's variable glossary. | 578 | Project Reference Manual's variable glossary. |