summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual/sdk-intro.rst
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-24 16:27:54 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:33 +0100
commitc473fa229239752367c5d573160fc8738cf1907e (patch)
treef8520ba3aa3cf911333dbd31e38e9a52203a0285 /documentation/sdk-manual/sdk-intro.rst
parent4cd953989de42c7a83f666c23e077d53b016a1f1 (diff)
downloadpoky-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-intro.rst')
-rw-r--r--documentation/sdk-manual/sdk-intro.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/documentation/sdk-manual/sdk-intro.rst b/documentation/sdk-manual/sdk-intro.rst
index 1a07a9e7a9..fcb15a8592 100644
--- a/documentation/sdk-manual/sdk-intro.rst
+++ b/documentation/sdk-manual/sdk-intro.rst
@@ -56,8 +56,8 @@ toolchain binaries are produced for any given architecture. This feature
56takes advantage of the fact that the target hardware can be passed to 56takes advantage of the fact that the target hardware can be passed to
57``gcc`` as a set of compiler options. Those options are set up by the 57``gcc`` as a set of compiler options. Those options are set up by the
58environment script and contained in variables such as 58environment script and contained in variables such as
59```CC`` <&YOCTO_DOCS_REF_URL;#var-CC>`__ and 59:term:`CC` and
60```LD`` <&YOCTO_DOCS_REF_URL;#var-LD>`__. This reduces the space needed 60:term:`LD`. This reduces the space needed
61for the tools. Understand, however, that every target still needs a 61for the tools. Understand, however, that every target still needs a
62sysroot because those binaries are target-specific. 62sysroot because those binaries are target-specific.
63 63
@@ -66,7 +66,7 @@ The SDK development environment consists of the following:
66- The self-contained SDK, which is an architecture-specific 66- The self-contained SDK, which is an architecture-specific
67 cross-toolchain and matching sysroots (target and native) all built 67 cross-toolchain and matching sysroots (target and native) all built
68 by the OpenEmbedded build system (e.g. the SDK). The toolchain and 68 by the OpenEmbedded build system (e.g. the SDK). The toolchain and
69 sysroots are based on a `Metadata <&YOCTO_DOCS_REF_URL;#metadata>`__ 69 sysroots are based on a :term:`Metadata`
70 configuration and extensions, which allows you to cross-develop on 70 configuration and extensions, which allows you to cross-develop on
71 the host machine for the target hardware. Additionally, the 71 the host machine for the target hardware. Additionally, the
72 extensible SDK contains the ``devtool`` functionality. 72 extensible SDK contains the ``devtool`` functionality.
@@ -107,9 +107,9 @@ when considering which to build:
107+-----------------------+-----------------------+-----------------------+ 107+-----------------------+-----------------------+-----------------------+
108 108
109\* Extensible SDK contains the toolchain and debugger if 109\* Extensible SDK contains the toolchain and debugger if
110```SDK_EXT_TYPE`` <&YOCTO_DOCS_REF_URL;#var-SDK_EXT_TYPE>`__ is "full" 110:term:`SDK_EXT_TYPE` is "full"
111or 111or
112```SDK_INCLUDE_TOOLCHAIN`` <&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN>`__ 112:term:`SDK_INCLUDE_TOOLCHAIN`
113is "1", which is the default. \*\* Sysroot is managed through the use of 113is "1", which is the default. \*\* Sysroot is managed through the use of
114``devtool``. Thus, it is less likely that you will corrupt your SDK 114``devtool``. Thus, it is less likely that you will corrupt your SDK
115sysroot when you try to add additional libraries. \**\* You can add 115sysroot when you try to add additional libraries. \**\* You can add