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-working-projects.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-working-projects.rst')
-rw-r--r-- | documentation/sdk-manual/sdk-working-projects.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/documentation/sdk-manual/sdk-working-projects.rst b/documentation/sdk-manual/sdk-working-projects.rst index 1d001d1099..63f61de66d 100644 --- a/documentation/sdk-manual/sdk-working-projects.rst +++ b/documentation/sdk-manual/sdk-working-projects.rst | |||
@@ -79,7 +79,7 @@ project: | |||
79 | 79 | ||
80 | 4. *Cross-Compile the Project:* This command compiles the project using | 80 | 4. *Cross-Compile the Project:* This command compiles the project using |
81 | the cross-compiler. The | 81 | the cross-compiler. The |
82 | ```CONFIGURE_FLAGS`` <&YOCTO_DOCS_REF_URL;#var-CONFIGURE_FLAGS>`__ | 82 | :term:`CONFIGURE_FLAGS` |
83 | environment variable provides the minimal arguments for GNU | 83 | environment variable provides the minimal arguments for GNU |
84 | configure: $ ./configure ${CONFIGURE_FLAGS} For an Autotools-based | 84 | configure: $ ./configure ${CONFIGURE_FLAGS} For an Autotools-based |
85 | project, you can use the cross-toolchain by just passing the | 85 | project, you can use the cross-toolchain by just passing the |
@@ -167,7 +167,7 @@ demonstrates these variable behaviors. | |||
167 | In a new shell environment variables are not established for the SDK | 167 | In a new shell environment variables are not established for the SDK |
168 | until you run the setup script. For example, the following commands show | 168 | until you run the setup script. For example, the following commands show |
169 | a null value for the compiler variable (i.e. | 169 | a null value for the compiler variable (i.e. |
170 | ```CC`` <&YOCTO_DOCS_REF_URL;#var-CC>`__). $ echo ${CC} $ Running the | 170 | :term:`CC`). $ echo ${CC} $ Running the |
171 | SDK setup script for a 64-bit build host and an i586-tuned target | 171 | SDK setup script for a 64-bit build host and an i586-tuned target |
172 | architecture for a ``core-image-sato`` image using the current DISTRO | 172 | architecture for a ``core-image-sato`` image using the current DISTRO |
173 | Yocto Project release and then echoing that variable shows the value | 173 | Yocto Project release and then echoing that variable shows the value |