diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-24 16:27:54 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:33 +0100 |
commit | c473fa229239752367c5d573160fc8738cf1907e (patch) | |
tree | f8520ba3aa3cf911333dbd31e38e9a52203a0285 /documentation/sdk-manual/sdk-appendix-obtain.rst | |
parent | 4cd953989de42c7a83f666c23e077d53b016a1f1 (diff) | |
download | poky-c473fa229239752367c5d573160fc8738cf1907e.tar.gz |
sphinx: fix internal links
Many of the internal links were not converted probably from DocBook
using pandoc. After looking at the various patterns, the follow series
of 'naive' Python regexp were used to perform some additional
automatic conversion.
Also, since we rely on built-in glossary, all links to terms need to
use the sphinx :term: syntax.
This commit is generated using the following Python series of regexp:
line = re.sub("`+(\w+)`* <(\&YOCTO_DOCS_REF_URL;)?#var-\\1>`__",
":term:`\\1`",
line)
line = re.sub("`+do_([a-z_]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-tasks-\\1>`__",
":ref:`ref-tasks-\\1`",
line)
line = re.sub("`+([a-z_\-\*\.]+).bbclass`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
":ref:`\\1.bbclass <ref-classes-\\1>`",
line)
line = re.sub("`+([a-z_\-\*\.]+)`* <(\&YOCTO_DOCS_REF_URL;)?#ref-classes-\\1>`__",
":ref:`\\1 <ref-classes-\\1>`",
line)
line = re.sub("`Source Directory <(\&YOCTO_DOCS_REF_URL;)?#source-directory>`__",
":term:`Source Directory`",
line)
line = re.sub("`Build Directory <(\&YOCTO_DOCS_REF_URL;)?#build-directory>`__",
":term:`Build Directory`",
line)
line = re.sub("`Metadata <(\&YOCTO_DOCS_REF_URL;)?#metadata>`__",
":term:`Metadata`",
line)
line = re.sub("`BitBake <(\&YOCTO_DOCS_REF_URL;)?#bitbake-term>`__",
":term:`BitBake`",
line)
line = re.sub("`Images <(\&YOCTO_DOCS_REF_URL;)?#ref-images>`__",
":ref:`ref-manual/ref-images:Images`",
line)
line = re.sub("`Classes <(\&YOCTO_DOCS_REF_URL;)?#ref-classes>`__",
":ref:`ref-manual/ref-classes:Classes`",
line)
line = re.sub("`workspace <(\&YOCTO_DOCS_REF_URL;)?#devtool-the-workspace-layer-structure>`__",
":ref:`devtool-the-workspace-layer-structure`",
line)
line = re.sub("`Open-?Embedded b?B?uild s?S?ystem <(\&YOCTO_DOCS_REF_URL;)?#build-system-term>`__",
":term:`OpenEmbedded Build System`",
line)
line = re.sub("`(OpenEmbedded-Core )?(\(?OE-Core\)? )?<(\&YOCTO_DOCS_REF_URL;)?#oe-core>`__",
":term:`OpenEmbedded-Core (OE-Core)`",
line)
It won't catch multiline strings, but it catches a very large number
of occurences!
(From yocto-docs rev: 3f537d17de5b1fb76ba3bee196481984a4826378)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/sdk-appendix-obtain.rst')
-rw-r--r-- | documentation/sdk-manual/sdk-appendix-obtain.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/documentation/sdk-manual/sdk-appendix-obtain.rst b/documentation/sdk-manual/sdk-appendix-obtain.rst index 1c69b3254d..c6efdf674c 100644 --- a/documentation/sdk-manual/sdk-appendix-obtain.rst +++ b/documentation/sdk-manual/sdk-appendix-obtain.rst | |||
@@ -95,14 +95,14 @@ build the SDK installer. Follow these steps: | |||
95 | 95 | ||
96 | 4. *Make Sure You Are Building an Installer for the Correct Machine:* | 96 | 4. *Make Sure You Are Building an Installer for the Correct Machine:* |
97 | Check to be sure that your | 97 | Check to be sure that your |
98 | ```MACHINE`` <&YOCTO_DOCS_REF_URL;#var-MACHINE>`__ variable in the | 98 | :term:`MACHINE` variable in the |
99 | ``local.conf`` file in your Build Directory matches the architecture | 99 | ``local.conf`` file in your Build Directory matches the architecture |
100 | for which you are building. | 100 | for which you are building. |
101 | 101 | ||
102 | 5. *Make Sure Your SDK Machine is Correctly Set:* If you are building a | 102 | 5. *Make Sure Your SDK Machine is Correctly Set:* If you are building a |
103 | toolchain designed to run on an architecture that differs from your | 103 | toolchain designed to run on an architecture that differs from your |
104 | current development host machine (i.e. the build host), be sure that | 104 | current development host machine (i.e. the build host), be sure that |
105 | the ```SDKMACHINE`` <&YOCTO_DOCS_REF_URL;#var-SDKMACHINE>`__ variable | 105 | the :term:`SDKMACHINE` variable |
106 | in the ``local.conf`` file in your Build Directory is correctly set. | 106 | in the ``local.conf`` file in your Build Directory is correctly set. |
107 | 107 | ||
108 | .. note:: | 108 | .. note:: |
@@ -138,7 +138,7 @@ build the SDK installer. Follow these steps: | |||
138 | binaries. If you want to use the toolchain to build these types | 138 | binaries. If you want to use the toolchain to build these types |
139 | of libraries, you need to be sure your SDK has the appropriate | 139 | of libraries, you need to be sure your SDK has the appropriate |
140 | static development libraries. Use the | 140 | static development libraries. Use the |
141 | ```TOOLCHAIN_TARGET_TASK`` <&YOCTO_DOCS_REF_URL;#var-TOOLCHAIN_TARGET_TASK>`__ | 141 | :term:`TOOLCHAIN_TARGET_TASK` |
142 | variable inside your ``local.conf`` file before building the | 142 | variable inside your ``local.conf`` file before building the |
143 | SDK installer. Doing so ensures that the eventual SDK | 143 | SDK installer. Doing so ensures that the eventual SDK |
144 | installation process installs the appropriate library packages | 144 | installation process installs the appropriate library packages |
@@ -189,7 +189,7 @@ Follow these steps to extract the root filesystem: | |||
189 | filesystem image's profile: lsb, lsb-dev, lsb-sdk, minimal, | 189 | filesystem image's profile: lsb, lsb-dev, lsb-sdk, minimal, |
190 | minimal-dev, minimal-initramfs, sato, sato-dev, sato-sdk, | 190 | minimal-dev, minimal-initramfs, sato, sato-dev, sato-sdk, |
191 | sato-sdk-ptest. For information on these types of image profiles, see | 191 | sato-sdk-ptest. For information on these types of image profiles, see |
192 | the "`Images <&YOCTO_DOCS_REF_URL;#ref-images>`__" chapter in the | 192 | the ":ref:`ref-manual/ref-images:Images`" chapter in the |
193 | Yocto Project Reference Manual. arch is a string representing the | 193 | Yocto Project Reference Manual. arch is a string representing the |
194 | target architecture: beaglebone-yocto, beaglebone-yocto-lsb, | 194 | target architecture: beaglebone-yocto, beaglebone-yocto-lsb, |
195 | edgerouter, edgerouter-lsb, genericx86, genericx86-64, | 195 | edgerouter, edgerouter-lsb, genericx86, genericx86-64, |